Move to SI Units + Redefine magnetization and add codependency with polarization (magpylib#712)

* magnetization-polarization step 1

* untrack non-python __temp files

* next update

* fix cuboid

* MU0

* fixing bh cuiboid again

* cuboid fix again

* another cube field fix

* field_BH_cylinder fix

* fix field_BH_sphere

* Cylinder segment

* core tetrahedron and triangle

* field_BH_triangularmesh fixed

* typo

* signular to plural

* current loop core

* field core polyline fix

* minifix docstring

* fixed dipole

* core tests und 2 bugfixes

* long solenoid test

* comments

* core physics tests

* complete core testing

* fix core examples

* fix Cuboid units

* fix Cylinder

* fix CylinderSegment

* fix Sphere

* fix magnetization docstring

* fix Tetrahedron

* fix TriangularMesh

* fix Collection

* fix Circle

* fix Polyline

* fix CustomSource

* fix Dipole

* fix Triangle

* fix Sensor

* Fix wrapBH

* Fix doctests

* fix loop and line deprecation

* pylint on magpylib folder

* fix test compound setters

* add pol and mag initialization(needed for repr)

* fix mpl tests

* fix _default_style_description units

* fix display plotly tests

* fix display pyvista test

* fix exceptins tests

* allow pol and mag to be np arrays

* fix field cylinder tests

* avoid low mag warnings on display tests

* fix getBH tests (up to dipole)

* fix input checks tests

* fix numerical stability

* fix base geo tests

* fix test paths

* fix utility tests

* fix test vs mag2

* fix scaling test

* fix physics consistency tests

* fix Collection tests (up to Dipole fail)

* fix Cuboid tests

* fix Cylinder tests

* fix CylinderSegment tests

* fix TriangularMesh tests

* fix Triangle tests

* fix Tetrahedron tests

* fix Sphere tests

* fix Sensor tests

* fix Polyline tests

* pylint

* fix Circle tests

* fix Dipole and Dipole tests

* fix missing modules tests

* adapt bugreport

* more positional avoided in tests

* fix class_BaseExcitations docstrings

* describe "degrees" -> "deg"

* bugfix: added moment unit to describe

* docstring missing SI

* docstring fix SI

* Collection docstrings fixes SI

* SI fix circle class

* docstrings to SI

* field wrap SI units fix

* test bugfix include now fix magpylib#279 (cylinder bug)

* update

* update Readme

* rework readme

* fix test

* fix test

* replace units to SI in docstrings (code only)

* fix units in get started

* replace dot separator (mpl font compat)

* fix units docu graphics

* rename direct interface to functional interface

* reorder docstring parameters

* reorder param customsource

* fix units in docu magpylib api

* Fix end of shaft

* fix compound example

* add virutal documents (from myst & jupytext)

* fix field interpolation

* fix shapes convex hull

* fix shapes pyvista

* bump to v5 dev version

* bad columns v5 vs v4

* fix shapes superpos

* fix shapes triangle

* fix tutorial collection

* fix tutorial field computation

* fix tutorial path

* better unit exponent display

* fix tutorial custom

* rework tutorial field computation

* fix tutorial trimesh

* fix vis mpl streamplot

* fix vis pv streamlines

* unpin pyvista version

* fix units

* fix Sensor default description and allow pixel=None

* remove news

* update docs

* upgrade sphinx

* add missing changelog dates

* remove obsolete ipygany and kaleido

* fix tests

* pylint

* fix pyvista + tests

* fix pyvista animation test

* code ql

* fix field_func input_checks tests

* add input_check sensor handedness

* BaseExcitation coverage

* fix different_pixel_shapes test

* fix legend style and description handling + tests

* pylint

* fix pyvista animation tests on CI

* empty commit

* offscreen pyvista animation test

* avoid test syntax collision with pytest + doctests

* fix missing pyvista test pollution

* override parent order

* override_parent

* some docu fixes

* new image

---------

Co-authored-by: Alexandre Boisselet <[email protected]>
Co-authored-by: Boisselet Alexandre (IFAT DC ATV SC D TE2) <[email protected]>
Co-authored-by: Alexandre Boisselet <[email protected]>

Author: 3 people

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -12,11 +12,11 @@ body:
       label: Magpylib version
       description: What version of Magpylib are you running?
       options:
+        - 5.x (Unreleased)
         - 4.x (Latest)
         - 3.x
         - 2.x
         - 1.x
-        - Unreleased
     validations:
       required: true
   - type: textarea
@@ -37,7 +37,7 @@ body:
         import numpy as np
         import magpylib as magpy
 
-        cuboid = magpy.magnet.Cuboid((0,0,1000), (1,1,1))
+        cuboid = magpy.magnet.Cuboid(polarization=(0.,0.,1.), dimension=(1.,1.,1.))
         cuboid.move(np.linspace((0,0,0), (0,0,10), 11), start=0)
         cuboid.show()
       render: Python

.gitignore

@@ -92,6 +92,7 @@ target/
 # Jupyter Notebook
 .ipynb_checkpoints
 *.ipynb
+.virtual_documents/
 
 # IPython
 profile_default/