The bug causes the devices not to synchronise under any conditions and exists only in #47.

To be fixed by appropriate revert.

Problem

Currently, none of the objects are pickle able.

Solution

Try to introduce pickle support through pybind11
https://pybind11.readthedocs.io/en/latest/advanced/classes.html#pickling-support

Currently dipole coupling between two devices is possible if simulated as "one device".
An abstraction should be added to make this obvious -- for example by extension of the Stack e.g. DipoleCoupledStack.

After pip installation the hints for the pyi.typed files may not be packaged properly and hence may not work properly.

Fix is to properly package typing hints with in the setup.cfg file.

Domain dynamics should have a simple visualisation to show an animation of the domain displacement, angle change and potentially also speed.

Drivers need a smart-pointer overhaul to reduce complexity of adding a new scalar driver.

Some users may not be able to successfully benefit from pip install, perhaps it's better to have the docker image built.

If we want to set a constant value for an Axial driver we need to do something like:

AxialDriver(ScalarDriver.getConstantDriver(H[0]),
            ScalarDriver.getConstantDriver(H[1]),
            ScalarDriver.getConstantDriver(H[2])))

instead, perhaps an easier way:

AxialDriver(*H)

Scalar Driver can also be assumed to be constant by default:

ScalarDriver(val) == ScalarDriver.getConstantDriver(val)

There are use cases where DMI interaction is a good addition for the macrospin model.

Override the scalar driver to be able to pass just a value and make it constant by default.
See if this can be propagated to the layer/junction api.

• add frequency limiter
• add ploty for interactive plots
• fix optimizer
• add the option to fix a parameter

Check if in the the thermal torque generation we are properly converting to A/m, despite Ms being in T.

Right now we sample noise in all directions -- allowing the user to specify just a single direction would be useful.

Driver functions should be aliased on both C++ and Python level for quicker reference and more reasonable naming convention.

Add a pipeline that auto deploys on doc push on master.

Should switch to pyproject.toml if possible to avoid using ancient setup.py-based builds.

• Passing a CVector to an axial driver automatically creates constant Driver.
• CVectors should be subscriptable in Python as well.

Integrate basic parallelism for HEBO optimisation in the optimisation submodule.

LLB equation is rather important for finite temp. computations.
It should be an easy extension for the existing basis.

Refs:
[1] Macrospin LLB in CoNi/Pd: https://hal.science/hal-01345392/document

It'd be useful to include dipole tensor interaction for the SB model

$$E_\mathrm{AFM/FM} = -\mu_0M_st_\mathrm{FM}(H_\mathrm{EB} + H_\mathrm{w})\cos\phi_M$$
or from Meiklejohn-Bean model.

W. H. Meiklejohn and C. P. Bean. New Magnetic Anisotropy. Physical Review, 102(5):1413–1414, June
1956. Publisher: American Physical Society.

E. C. Stoner and E. P. Wohlfarth. Interpretation of High Coercivity in Ferromagnetic Materials. Na-
ture, 160(4071):650–651, November 1947. Number: 4071 Publisher: Nature Publishing Group.

Issues:

• squeeze to be removed here:
  

  cmtj/cmtj/utils/procedures.py

  Line 138 in 90b77f4

  mixed = np.squeeze(mixed)

• tqdm quiet needs to be passed in all procedures

Test the following things:

• Drivers.
• Procedures.
• Junction creation.

Using pytest and automatic tests for push is desirable.

1. Create a simple display interface
2. Sliders for parameter adjustments
3. Load experimental points
4. Simulate & replot

Just do PIMM and perhaps use gradio.app ?

Implement perturbation in C++ for the magnetisation vector.

This is now implemented in procedures, but in Python. Should be repeated for C++.

A relax function would be useful.
It could either:

1. Minimise the energy
2. Minimise the torque