[rozyczko]

Documentation and User Guide Updates:

• Added a new user guide page user-guide/magnetism.md detailing magnetism conventions, limitations, and new features such as Model.guide_field_angle, Model.applied_field, and MaterialMagnetic. The changelog summarizes all major changes related to magnetism, including new methods, parameters, and changes to ORSO model import/export.
• Updated the main user guide index to reference the new magnetism page, clarify that only Refl1D supports magnetism, and document MaterialMagnetic as a new material type.

Tutorial Enhancements:

• Significantly revised the advanced polarized fitting tutorial (polarized_fitting.ipynb) to:

  • Accurately describe spin-resolved SLDs as nuclear SLD plus/minus the magnetic SLD along the field, with clear explanations and references to the new magnetism guide.
  • Add a new section and example on fitting the magnetic moment in Bohr magnetons using MaterialMagnetic and rho_m_coupled.
  • Import MaterialMagnetic where relevant.

• Updated the simulation tutorial (magnetism.ipynb) to:

  • Reference the new magnetism guide and clarify conventions.
  • Show usage of MaterialMagnetic and demonstrate coupling a layer’s magnetic SLD to the material’s moment.
  • Add explicit examples for setting the guide field and applied field in models, and plot their effects.

[codecov]

Codecov Report

❌ Patch coverage is 97.90941% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.69%. Comparing base (66adaf5) to head (ca93529).

Files with missing lines	Patch %	Lines
...try/sample/elements/materials/material_magnetic.py	91.07%	5 Missing ⚠️
...rc/easyreflectometry/calculators/refl1d/wrapper.py	85.71%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #439      +/-   ##
===========================================
+ Coverage    95.41%   95.69%   +0.28%     
===========================================
  Files           59       60       +1     
  Lines         7042     7294     +252     
===========================================
+ Hits          6719     6980     +261     
+ Misses         323      314       -9     

Flag	Coverage Δ
integration	38.93% <29.96%> (-0.22%)	⬇️
unittests	95.69% <97.90%> (+0.28%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...easyreflectometry/calculators/refl1d/calculator.py	100.00% <ø> (ø)
src/easyreflectometry/contrasts.py	100.00% <100.00%> (ø)
src/easyreflectometry/model/model.py	98.30% <100.00%> (+0.20%)	⬆️
src/easyreflectometry/orso_utils.py	96.04% <100.00%> (+1.64%)	⬆️
src/easyreflectometry/project.py	95.19% <100.00%> (+0.15%)	⬆️
src/easyreflectometry/sample/__init__.py	100.00% <100.00%> (ø)
.../easyreflectometry/sample/elements/layers/layer.py	97.72% <100.00%> (+1.57%)	⬆️
...etry/sample/elements/materials/material_density.py	99.18% <100.00%> (+0.03%)	⬆️
src/easyreflectometry/special/calculations.py	100.00% <100.00%> (ø)
...rc/easyreflectometry/calculators/refl1d/wrapper.py	97.57% <85.71%> (+0.03%)	⬆️
... and 1 more

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.