Examples

End-to-end workflows are shown in the following set of tutorials:

Workflows

• mammos
  • Hard magnet tutorial
  • Hard magnet material exploration
  • Sensor shape optimization workflow

Further examples for the individual packages are available in these tutorials:

Packages

• mammos-analysis
  • mammos_analysis quickstart
• mammos-dft
  • mammos_dft quickstart
• mammos-entity
  • mammos_entity quickstart
• mammos-mumag
  • mammos_mumag quickstart
• mammos-spindynamics
  • mammos_spindynamics quickstart
• mammos-units
  • mammos_units quickstart
  • Unit Conversions

Downloading all examples

To conveniently download all example notebooks use the mammos-fetch-examples script, which is installed as part of the mammos package. All notebooks are written to a new examples directory with a subdirectory per package. The command fails if a directory or file with the name example exists in the current working directory.

Upon completion a list of downloaded examples is displayed:

$ mammos-fetch-examples
Downloading examples...
The following examples have been downloaded:
examples/mammos/hard-magnet-material-exploration.ipynb
examples/mammos/hard-magnet-tutorial.ipynb
examples/mammos/sensor.ipynb
examples/mammos-analysis/quickstart.ipynb
examples/mammos-dft/quickstart.ipynb
examples/mammos-entity/quickstart.ipynb
examples/mammos-mumag/quickstart.ipynb
examples/mammos-spindynamics/quickstart.ipynb
examples/mammos-units/example.ipynb
examples/mammos-units/quickstart.ipynb