Doku rework (magpylib#660)

* rework readme

* readme2

* readme3

* readmy4

* readmy4

* readme5

* readme

* readme

* readme

* readme

* readme

* readme

* readme

* readme

* readme

* readme

* readme

* readme

* readme

* readme

* readme

* readme

* readme again

* readmeeeee

* readme

* readme

* readme

* readme

* docs index

* test black badge

* readme

* readme

* contribution guide first try

* cont readme

* contr

* contr

* test

* conti

* removed [...] around units in Text or replaced them by (...) in plots. Still needs to be done separately in plotly graphics backend for coordinates

* conti

* fixing unit formatting finished

* conti

* pylint fix

* pylint fix

* complete conti guide

* Merge branch 'docs-revamp' of https://github.com/magpylib/magpylib into doku_rework

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md again

* dont like it

* fork contrib

* nachziehen

* toctree

* base docu structure

* sphinx-gallery to requirements

* try fix gallery

* gallery image compilation

* example stream

* sphinx gallery

* docs

* ignore auto_examples

* sg - icon1

* docs - improve example

* sg - remove download all

* add pyvista sphinx gallery

* remove old static images

* docs adjustment

* back 2 markdown, restructure

* base structure with sphinx-design

* improve style

* docs getting better

* new base structure

* docu get started

* doku

* a lot of docu

* docu

* docu

* docu grafix

* docu

* Many instances of [unit] removed

* doku

* doku something

* Revert "Merge branch 'doku_rework' of https://github.com/magpylib/magpylib into doku_rework"

This reverts commit f7294dc, reversing
changes made to 180a34f.

* units to cuboid class

* docu improvements

* docu

* update PRs

* update version number

* spellcheck modules

* docs spellcheck

* fix style example

* draft update graphics section

* dokudoku

* more doku

* update graphics docs

* update

* gallery gallery

* doku

* gallery triangle

* compound example

* tutorial paths

* collection tutorial

* gallery field computation

* image fix

* docu rearrange

* minifix

* doku prepare

* fixing small things

* docu

---------

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

Author: 5 people

.gitignore

@@ -29,6 +29,12 @@ share/python-wheels/
 *.egg
 MANIFEST
 
+# docs
+docs/auto_examples
+
+# sphinx-gallery
+auto_examples
+
 # coderunner
 tempCodeRunnerFile.py
 

CHANGELOG.md

@@ -1,11 +1,15 @@
 All notable changes to magpylib are documented here.
 
 
-# Releases
+# Changelog
 
-## [4.4.0] 
-- include self-intersection check in `TriangularMesh` ([#589](https://github.com/magpylib/magpylib/issues/589)).
-- disconnected line
+## [4.4.0dev] - Unreleased
+- Included self-intersection check in `TriangularMesh` ([#622](https://github.com/magpylib/magpylib/pull/622)).
+- Fixed incorrect edge case of TriangularMesh reorientation ([#644](https://github.com/magpylib/magpylib/pull/644))
+- Discontinuous segments in `current.Line` are now accepted and correctly treated as separate lines ([#632](https://github.com/magpylib/magpylib/pull/632), [#642](https://github.com/magpylib/magpylib/pull/642)).
+- Objects can now be displayed with missing dimension and/or excitation ([#640](https://github.com/magpylib/magpylib/pull/640)).
+- Added magnetization and current arrows `sizemode` styling option (absolute or scaled) ([#639](https://github.com/magpylib/magpylib/pull/639)).
+- `Collection` objects now also have a default description when displayed (number of chidren) ([#634](https://github.com/magpylib/magpylib/pull/634)).
 
 ## [4.3.0] - 2023-06-25
 - New `TriangularMesh` magnet class added to conveniently work with triangular surface meshes instead of large collections of individual `Triangle` objects. The `TriangularMesh` class performs important checks (closed, connected, oriented) and can directly import pyvista objects and for convex hull bodies. ([#569](https://github.com/magpylib/magpylib/issues/569), [#598](https://github.com/magpylib/magpylib/pull/598)).
@@ -223,7 +227,7 @@ This is a major update that includes
 - Renamed attributes (parameters cannot be initialized in their short forms anymore):
     - `angle` and `axis` are replaced by `orientation`
     - `dimension` is replaced by `diameter` for Loop and Sphere classes.
-    - `angle`&`axis` are replaced by `orientation` (see [Added](### Added) Section)
+    - `angle`&`axis` are replaced by `orientation`.
 
 - Modified rotate methods:
   - The class methods `.rotate(angle, axis, anchor)` have been replaced by a new `.rotate(rotation, anchor, increment, start)` method where `rotation` ist a scipy `Rotation` object.
@@ -252,7 +256,7 @@ This is a major update that includes
       - Objects with shorter paths will be considered as static once their path ends while other paths still continue.
     4. `magpylib.getBv(**kwargs)` gives direct access to the field formulas and mostly replaces the `getBv_XXX()` functionality of v2. All inputs must be arrays of length N or of length 1 (statics will be tiled).
   - While `getBv` is the fastest way to compute the fields it is much more convenient to use `getB()` which mostly provides the same performance. Specifically,the new `getB()` automatically groups all inputs for combined vectorized evaluation. This leads to a massive speedup when dealing with large Collections of similar sources.
-  - In addition to `getB`, the new `getH` returns the field in [kA/m].
+  - In addition to `getB`, the new `getH` returns the field in kA/m.
 
 ### Removed
 - the kwarg `niter=50` does not exist anymore for the Cylinder field computation. The functionality was completely replaced by the config setting `Config.ITER_CYLINDER=50`.
@@ -415,7 +419,7 @@ The first official release of the magpylib library.
 
 ---
 
-[Unreleased]:https://github.com/magpylib/magpylib/compare/4.3.0...HEAD
+[4.4.0dev]:https://github.com/magpylib/magpylib/compare/4.3.0...HEAD
 [4.3.0]:https://github.com/magpylib/magpylib/compare/4.2.0...4.3.0
 [4.2.0]:https://github.com/magpylib/magpylib/compare/4.1.2...4.2.0
 [4.1.2]:https://github.com/magpylib/magpylib/compare/4.1.1...4.1.2