Merge branch 'use-scientific-python-pypackage-base' of https://github.com/magpylib/magpylib-material-response into use-scientific-python-pypackage-base

Author: Alexboiboi

CHANGELOG.md

@@ -1,19 +1,28 @@
 # Unreleased
 
 # 0.3.0
-* improved interface for chi input
-* FE tests for anisotropic chi and negative chi
-* Improve internals
-* anisotropic susceptibilities are now allowed.
-* Improve suszeptibility input possibilities:
-    - give susceptibility to parent collection
-    - if susceptiblity input is scalar, isotropic susceptibility is assumed, if it is a 3-vector it can be anisotropic
-* Various tests included of interface and computation, isotropic and anisotropic tests confirm computaiton
+
+- improved interface for chi input
+- FE tests for anisotropic chi and negative chi
+- Improve internals
+- anisotropic susceptibilities are now allowed.
+- Improve suszeptibility input possibilities:
+  - give susceptibility to parent collection
+  - if susceptiblity input is scalar, isotropic susceptibility is assumed, if it
+    is a 3-vector it can be anisotropic
+- Various tests included of interface and computation, isotropic and anisotropic
+  tests confirm computaiton
 
 # 0.2.1a0
-* Fix null polarization for rotated objects ([#7](https://github.com/magpylib/magpylib-material-response/pull/7))
-* Fix docs not building ([#6](https://github.com/magpylib/magpylib-material-response/pull/6))
+
+- Fix null polarization for rotated objects
+  ([#7](https://github.com/magpylib/magpylib-material-response/pull/7))
+- Fix docs not building
+  ([#6](https://github.com/magpylib/magpylib-material-response/pull/6))
 
 # 0.2.0a0
-* renaming xi->susceptibility ([#5](https://github.com/magpylib/magpylib-material-response/pull/5))
-* update to magpylib v5 ([#4](https://github.com/magpylib/magpylib-material-response/pull/4))
+
+- renaming xi->susceptibility
+  ([#5](https://github.com/magpylib/magpylib-material-response/pull/5))
+- update to magpylib v5
+  ([#4](https://github.com/magpylib/magpylib-material-response/pull/4))

README.md

@@ -26,7 +26,10 @@
 
 <!-- prettier-ignore-end -->
 
-> **Warning**
-> **This package is experimental and in development phase, breaking API changes may happen at any time.**
+> **Warning** > **This package is experimental and in development phase,
+> breaking API changes may happen at any time.**
 
-Magpylib-Material-Response is an extension to the Magpylib library, providing magnetic field analysis for soft materials and demagnetization of hard magnets. Leveraging the Method of Moments, it calculates magnetic material response by meshing sources in an arbitrary number of unit elements.
+Magpylib-Material-Response is an extension to the Magpylib library, providing
+magnetic field analysis for soft materials and demagnetization of hard magnets.
+Leveraging the Method of Moments, it calculates magnetic material response by
+meshing sources in an arbitrary number of unit elements.

docs/examples/cuboids_demagnetization.md

@@ -14,7 +14,16 @@ kernelspec:
 
 # Cuboids demagnetization
 
-The following example demonstrates how to create magnetic sources with different susceptibilities using the Magpylib library. It defines three cuboid magnets with varying susceptibilities and positions, creates a collection of these magnets, and computes their magnetic field responses using different levels of meshing. The results are then compared to a Finite Element Method (FEM) analysis to evaluate the performance of the Magpylib-Material-Response approach. The comparison is presented in two separate plots, one showing the magnetic field values and the other showing the difference between the Magpylib results and the FEM reference data. The code demonstrates that even with a low number of mesh elements, the Magpylib results quickly approach the reference FEM values.
+The following example demonstrates how to create magnetic sources with different
+susceptibilities using the Magpylib library. It defines three cuboid magnets
+with varying susceptibilities and positions, creates a collection of these
+magnets, and computes their magnetic field responses using different levels of
+meshing. The results are then compared to a Finite Element Method (FEM) analysis
+to evaluate the performance of the Magpylib-Material-Response approach. The
+comparison is presented in two separate plots, one showing the magnetic field
+values and the other showing the difference between the Magpylib results and the
+FEM reference data. The code demonstrates that even with a low number of mesh
+elements, the Magpylib results quickly approach the reference FEM values.
 
 +++
 
@@ -164,4 +173,5 @@ fig2.update_yaxes(matches=None, showticklabels=True)
 display(fig1, fig2)
 ```
 
-As shown above, already with a low number of mesh elements, the result is approaching the reference FEM values and improves while refining the mesh.
+As shown above, already with a low number of mesh elements, the result is
+approaching the reference FEM values and improves while refining the mesh.

docs/examples/soft_magnets.md

@@ -18,8 +18,11 @@ kernelspec:
 
 +++
 
-This code demonstrates demagnetization calculations for a hard and a soft cuboid magnet using the Magpylib library.
-Demagnetization is applied using varying numbers of cells for the mesh and compared to the computed magnetic fields from Magpylib withoug demagnetization and with FEM analysis data obtained from an external dataset.
+This code demonstrates demagnetization calculations for a hard and a soft cuboid
+magnet using the Magpylib library. Demagnetization is applied using varying
+numbers of cells for the mesh and compared to the computed magnetic fields from
+Magpylib withoug demagnetization and with FEM analysis data obtained from an
+external dataset.
 
 +++ {"user_expressions": []}
 
@@ -172,4 +175,5 @@ display(fig1, fig2)
 
 +++ {"user_expressions": []}
 
-As shown above, the demagnetized collection outputs are approaching the reference FEM values while refining the mesh.
+As shown above, the demagnetized collection outputs are approaching the
+reference FEM values while refining the mesh.