Skip to content

Commit

Permalink
back to main
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexboiboi committed Apr 21, 2024
1 parent a9817fc commit b89a3b5
Showing 1 changed file with 6 additions and 38 deletions.
44 changes: 6 additions & 38 deletions docs/index.md
@@ -1,41 +1,21 @@
# The Magpylib Documentation

::::{grid}
:class-container: sd-px-1
:gutter: 1

:::{grid-item}
:columns: 12
Magpylib is an **open-source Python package** for calculating static **magnetic fields** of magnets, currents and other sources. It uses **explicit expressions**, solutions to the macroscopic magnetostatic problems, implemented in **vectorized** form which makes the computation **extremely fast**. Make use of the open-source Python ecosystem for spectacular visualization.
:::

:::{grid-item}
:columns: 12
<div class="sectiontext">
<h2>How it works</h2>
</div>
:::
## How it works

:::{grid-item}
:columns: 12
![](_static/images/index_flowchart.png)
:::

:::{grid-item}
:columns: 12
In Magpylib, **sources** (magnets, currents, ...) and **observers** (sensors, position grids, ...) are created as Python objects with position and orientation attributes. These objects can be **grouped** and **moved** around. The system can be **viewed** graphically through various backends. The **magnetic field** is computed in the observer reference frame. Magpylib collects all inputs, and vectorizes the computation for maximal performance.
:::

:::{grid-item}
:columns: 12
<div class="sectiontext">
<h2>Resources</h2>
</div>
:::
## Resources

::::{grid} 2 3 3 6
:margin: 4 4 0 0
:gutter: 2

:::{grid-item-card}
:columns: 2
:padding: 1
:link: get-started
:link-type: ref
:link-alt: link to Getting Started
Expand All @@ -45,8 +25,6 @@ In Magpylib, **sources** (magnets, currents, ...) and **observers** (sensors, po
:::

:::{grid-item-card}
:columns: 2
:padding: 1
:link: docu-index
:link-type: ref
:link-alt: link to Documentation
Expand All @@ -56,8 +34,6 @@ In Magpylib, **sources** (magnets, currents, ...) and **observers** (sensors, po
:::

:::{grid-item-card}
:columns: 2
:padding: 1
:link: gallery
:link-type: ref
:link-alt: link to Examples
Expand All @@ -67,8 +43,6 @@ In Magpylib, **sources** (magnets, currents, ...) and **observers** (sensors, po
:::

:::{grid-item-card}
:columns: 2
:padding: 1
:link: contributing
:link-type: ref
:link-alt: link to Contribution Guide
Expand All @@ -78,8 +52,6 @@ In Magpylib, **sources** (magnets, currents, ...) and **observers** (sensors, po
:::

:::{grid-item-card}
:columns: 2
:padding: 1
:link: https://github.com/magpylib/magpylib
:link-alt: link to Github
:img-top: _static/images/index_icon_github.png
Expand All @@ -88,8 +60,6 @@ In Magpylib, **sources** (magnets, currents, ...) and **observers** (sensors, po
:::

:::{grid-item-card}
:columns: 2
:padding: 1
:link: https://www.sciencedirect.com/science/article/pii/S2352711020300170
:link-alt: link to Journal
:img-top: _static/images/index_icon_academic.png
Expand All @@ -101,9 +71,7 @@ In Magpylib, **sources** (magnets, currents, ...) and **observers** (sensors, po

```{toctree}
:maxdepth: 2
:hidden:
_pages/reso_news.md
_pages/reso_get_started.md
_pages/docu/docu_index.md
_pages/gallery/gallery_index.md
Expand Down

0 comments on commit b89a3b5

Please sign in to comment.