Changelog

The format follows Keep a Changelog. Versions follow semantic versioning, the metapackage version is updated according to the largest bump of any of the dependent packages.

0.7.0 – 2025-11-03

Added

mammos-mumag

• Two new notebooks Hysteresis loop simulation and Additional functionality available with mammos_mumag documenting additional functionality of mammos-mumag. (PR42)

• Create cli command unv2fly to convert unv mesh to fly format. (PR61)

• Added notebook Using Tesla for information on how to set up a workflow in Tesla. (PR68)

• Added possibility to install GPU support (both CUDA and ROCm) with pip via the extra dependencies. (PR81)

Fixed

mammos-analysis

• The function mammos_analysis.kuzmin_properties() will not assume the magnetization input is in A/m. If the input is in a unit not convertible to A/m (e.g., Tesla), an error is raised. (PR31)

mammos-mumag

• Fixed default outdir input in two functions in mammos_mumag.simulation. (PR69)

Changed

mammos-mumag

• Now mammos_mumag.hysteresis.run() can be used to execute simulations with multigrain materials. (PR46)

• Implement automatic retries to download meshes if the requests fail. The requests will try three times in total, with a backoff factor of 0.1. (PR70)

• Documentation is updated. Parameters have been formatted to snake case when possible. The names h_start, h_final, h_step, n_h_steps, m_step, m_final, and tol_h_mag_factor take the place of hstart, hfinal, hstep, nhsteps, mstep, mfinal, and tol_hmag_factor. Whenever possible, reasonable entities have been defined. The unused variables iter_max, tol_u, and verbose have been removed. Warning: this PR causes failure in previously defined workflows if the variables were defined by the user. (PR71)

Misc

mammos-mumag

• Added Hysteresis loop simulation to document full functionality of mammos-mumag when running a hysteresis loop simulation. Additionally, show the functionality of the package irrelevant to an average user in Additional functionality available with mammos_mumag. (PR42)

0.6.0 – 2025-08-13

Added

mammos-entity

• CSV files written with mammos_entity.io can now optionally contain a description. (PR52)

• Support for YAML as additional file format in mammos_entity.io. (PR59, PR69, PR70)

• Two new functions mammos_entity.io.entities_to_file() and mammos_entity.io.entities_from_file() to write and read entity files. The file type is inferred from the file extension. (PR57)

• A function mammos_entity.concat_flat() to concatenate compatible entities, quantities and array-likes into a single entity. (PR56)

mammos-mumag

• Add function mammos_mumag.hysteresis.read_result() to read the result of a hysteresis loop from a folder (without running the hysteresis calculation again). (PR48)

• Implement mammos_mumag.mesh.Mesh class that can read and display information of local meshes, meshes on Zenodo and meshes given by the user. (PR53)

Changed

mammos-analysis

• The Kuz’min formula to evaluate micromagnetic properties can now accept Curie Temperature Tc and spontaneous magnetisation at zero temperature Ms_0 as optional inputs. If given, they are not optimised by fitting the magnetisation curve. (PR12)

• The initial guess for the optimization of the Curie Temperature in Kuz’min formula is set to a much lower temperature (depending on the data). (PR18)

mammos-entity

• When reading files with mammos_entity.io IRIs are now checked in addition to ontology labels and file reading fails if there is a mismatch between IRI and ontology label. (PR68)

mammos-mumag

• Changed the output of the hysteresis loop in compliance with mammos_entity.io v2. (PR54)

Deprecated

mammos-entity

• The functions mammos.entity.io.entities_to_csv and mammos_entity.io.entities_from_csv have been deprecated. Use mammos_entity.io.entities_to_file() and mammos_entity.io.entities_from_file() instead. (PR58)

Fixed

mammos-entity

• On Windows, CSV files written with mammos-entity had blank lines between all data lines. (PR66)

• Writing CSV files with entities of different shapes 0 and 1, where elements with shape 0 were broadcasted is no longer supported as it is not round-trip safe. (PR67)

mammos-dft

• Update attribute name of uniaxial anisotropy constant to Ku_0 from K1_0 for the returned MicromagneticProperties object during a database lookup. (PR19)

mammos-mumag

• Fixed the default values of the MaterialDomain class. (PR41)

0.5.0 – 2025-07-11

Added

mammos-entity

• A new submodule mammos_entity.io that provides two functions to write and read CSV files with additional ontology metadata. For more details refer to the new io documentation. (PR29, PR46, PR47 )

Fixed

mammos-entity

• Fix bug when defining unitless entities. (PR37 and PR45)

0.4.0 – 2025-06-27

Changed

mammos-entity

• The Entity class is no longer a subclass of mammos_units.Quantity. As a consequence it does no longer support mathematical operations. Use the attribute .quantity (or the short-hand .q) to access the underlying quantity and to perform (mathematical) operations. (PR28)

• The package now comes with a bundled ontology consisting of EMMO (version 1.0.0-rc3) and Magnetic Material (version 0.0.3). Internet access is no longer required. (PR33)

mammos

• Use Fe16N2 instead of Nd2Fe14B in hard magnet workflow. (PR17)

0.3.0 – 2025-06-11

Added

mammos-entity

• New predefined entity mammos_entity.J

• New predefined entity mammos_entity.Js

mammos-mumag

• Optional argument plotter in plot_configuration to add a vector plot of a magnetization configuration to a pyvista.Plotter provided by the caller.

Changed

mammos-entity

• Return a mammos_units.UnitConversionError (inherited from astropy.units) when trying initialize an entity with incompatible units.

0.2.0 – 2025-06-06

Added

mammos

• Command-line script mammos-fetch-examples to download all example notebooks.

mammos-entity

• Entity objects have ontology_label_with_iri attribute.

Changed

mammos-entity

• When trying to initialize an entity with a wrong unit the error message does now show the required unit defined in the ontology.

Fixed

mammos-entity

• Entity.to did not return a new entity in the requested units and instead used the default entity units.

• Entity.axis_label: unit inside parentheses instead of brackets.

0.1.0 – 2025-06-05

Added

mammos – 0.1.0

• Workflows for hard magnets and sensor shape optimization.

• Ensures compatible software components are installed.

mammos-analysis – 0.1.0

• Calculation of macroscopic properties (Mr, Hc, BHmax) from a hysteresis loop.

• Fitting of the linear segment of a hysteresis loop.

• Calculation of temperature-dependent micromagnetic properties from atomistic spin dynamics simulations using Kuz’min equations.

mammos-dft – 0.3.0

• Database lookup functionality for a selection of pre-computed materials.

mammos-entity – 0.5.0

• Provides entities: quantities with links to the MaMMoS ontology (based on EMMO) by combining mammos-units and EMMOntoPy.

• Helper functions to simplify creation of commonly required magnetic entities.

mammos-mumag – 0.6.0

• Finite-element hysteresis loop calculations.

• Requires a separate installation of esys-escript.

mammos-spindynamics – 0.2.0

• Database lookup functionality for a selection of pre-computed materials.

mammos-units – 0.3.1

• Extension of astropy.units that allows working with quantities (units with values) containing additional units relevant for magnetism.