style: pre-commit fixes

Author: pre-commit-ci[bot]

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.

src/magpylib_material_response/data/__init__.py

@@ -2,6 +2,8 @@
 Built-in datasets for demonstration, educational and test purposes.
 """
 
+from __future__ import annotations
+
 
 def get_dataset(name):
     import json

src/magpylib_material_response/demag.py

@@ -2,6 +2,8 @@
 
 # +
 # pylint: disable=invalid-name, redefined-outer-name, protected-access
+from __future__ import annotations
+
 import sys
 from collections import Counter
 
@@ -55,25 +57,24 @@ def get_susceptibilities(sources, susceptibility):
                 susis.append(susceptibility)
             else:
                 raise ValueError("susceptibility is not scalar or array fo length 3")
+    # susceptibilities as input to demag function
+    elif np.isscalar(susceptibility):
+        susis = np.ones((n, 3)) * susceptibility
+    elif len(susceptibility) == 3:
+        susis = np.tile(susceptibility, (n, 1))
+        if n == 3:
+            raise ValueError(
+                "Apply_demag input susceptibility is ambiguous - either scalar list or vector single entry. "
+                "Please choose different means of input or change the number of cells in the Collection."
+            )
     else:
-        # susceptibilities as input to demag function
-        if np.isscalar(susceptibility):
-            susis = np.ones((n, 3)) * susceptibility
-        elif len(susceptibility) == 3:
-            susis = np.tile(susceptibility, (n, 1))
-            if n == 3:
-                raise ValueError(
-                    "Apply_demag input susceptibility is ambiguous - either scalar list or vector single entry. "
-                    "Please choose different means of input or change the number of cells in the Collection."
-                )
-        else:
-            if len(susceptibility) != n:
-                raise ValueError(
-                    "Apply_demag input susceptibility must be scalar, 3-vector, or same length as input Collection."
-                )
-            susis = np.array(susceptibility)
-            if susis.ndim == 1:
-                susis = np.repeat(susis, 3).reshape(n, 3)
+        if len(susceptibility) != n:
+            raise ValueError(
+                "Apply_demag input susceptibility must be scalar, 3-vector, or same length as input Collection."
+            )
+        susis = np.array(susceptibility)
+        if susis.ndim == 1:
+            susis = np.repeat(susis, 3).reshape(n, 3)
 
     susis = np.reshape(susis, 3 * n, order="F")
     return np.array(susis)
@@ -141,7 +142,7 @@ def demag_tensor(
 
     if pairs_matching and split != 1:
         raise ValueError("Pairs matching does not support splitting")
-    elif max_dist != 0:
+    if max_dist != 0:
         mask_inds, getH_params, pos0, rot0 = filter_distance(
             src_list, max_dist, return_params=False, return_base_geo=True
         )
@@ -179,7 +180,7 @@ def demag_tensor(
                         H_unit_pol = []
                         for split_ind, src_list_subset in enumerate(src_list_split):
                             logger.info(
-                                f"Sources subset {split_ind+1}/{len(src_list_split)}"
+                                f"Sources subset {split_ind + 1}/{len(src_list_split)}"
                             )
                             if src_list_subset.size > 0:
                                 H_unit_pol.append(

src/magpylib_material_response/meshing.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from collections import Counter
 from itertools import product
 

src/magpylib_material_response/meshing_utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from itertools import product
 
 import numpy as np