Skip to content

Commit 8ad857b

Browse files
committed
doku links
1 parent ddfd23f commit 8ad857b

File tree

4 files changed

+48
-22
lines changed

4 files changed

+48
-22
lines changed

docs/_pages/0_documentation.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1+
.. _docu:
2+
13
******************************
24
Documentation v2.0.0b
35
******************************
46

57
The idea behind magpylib is to provide a simple and easy-to-use interface
68
for computing the magnetic field of magnets, currents and moments. The
79
computation is based on (semi-)analytical solutions found in the literature
8-
discussed in the :ref:`physics&computation` section.
10+
discussed in the :ref:`physComp` section.
911

1012
Contents
1113
########
@@ -70,7 +72,7 @@ IO types
7072

7173
The library **input** is constructed so that any
7274

73-
- **scalar input** can be `int`, `float` or of `numpy.float` type
75+
- **scalar input** can be ``int``, ``float`` or of ``numpy.float`` type
7476
- **vector/matrix input** can be given either in the form of a `list`, as a `tuple` or as a `numpy.array`
7577

7678
unless specifically state otherwise in the docstrings. For example, the `magpylib.vector` functions require `numpy.array` input.

docs/_pages/1_how2install.rst

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
1+
.. _installation:
2+
13
*************************
24
Installation
35
*************************
46

7+
.. warning::
8+
Magpylib works only with Python 3.6 or later !
9+
510
Content
611
#######
712

813
* `Install with pip`_
914
* `Windows`_
15+
* `Linux`_
16+
* `Download Sites`_
17+
1018

11-
.. warning::
12-
Magpylib works only with Python 3.6 or later !
1319

1420
Install with pip
1521
################
@@ -22,6 +28,8 @@ The quickest installation on any platform is through pip.
2228
2329
If you are unfamiliar with pip, please follow the detailed guides below:
2430

31+
32+
2533
Windows
2634
#######
2735

@@ -33,35 +41,53 @@ If you have little experience with Python we recommand using `Anaconda <https://
3341
1. Download & install Anaconda3
3442
2. Start Anaconda Navigator
3543
3. On the interface, go to `Environments` and choose the environment you wish to install magpylib in. For this example, we will use the base environment:
36-
37-
..image:: ../_static/images/install_guide/anaconda0.png
44+
45+
.. image:: ../_static/images/install_guide/anaconda0.png
3846

3947
4. Click the arrow, and open the conda terminal
4048

41-
..image:: ../_static/images/install_guide/anaconda1.png
49+
.. image:: ../_static/images/install_guide/anaconda1.png
4250

4351
5. Input the following to install from conda-forge:
4452

45-
..code-block:: console
46-
47-
conda install -c conda-forge magpylib
53+
.. code-block:: console
54+
55+
conda install -c conda-forge magpylib
4856
4957
6. Dont forget to select the proper environment in your IDE.
5058

51-
..image:: ../_static/images/install_guide/anaconda2.png
59+
.. image:: ../_static/images/install_guide/anaconda2.png
5260

5361

5462
Clean Python 3 Install
5563
----------------------
5664

57-
If you want to have a custom environment without using conda, you may simply install the library with pip:
65+
If you want to have a custom environment without using conda, you may simply install the library with pip. A simple guide for installation and functionality of pip is found `here <https://projects.raspberrypi.org/en/projects/using-pip-on-windows/5>`_
66+
67+
68+
69+
Linux
70+
#######
71+
72+
Recommended: use Anaconda environment. Simply download Anaconda3 and follow installation steps as under Windows.
73+
74+
Terminal Python 3 Install
75+
--------------------------
76+
77+
1. Install Python3.
78+
2. Open your Terminal and install with
79+
80+
.. code-block:: console
81+
82+
pip install magpylib
83+
5884
59-
1. Install Python3
60-
2. Open `cmd.exe`
61-
3. Add Python to your path
62-
4. Install magpylib with the following command:
6385
64-
..code-block:: console
86+
Download Sites
87+
#################
6588

66-
python -m pip install magpylib
89+
Currently magpylib is hosted at:
6790

91+
* `Conda Cloud <https://anaconda.org/conda-forge/magpylib>`_
92+
* `Python Package Index <https://pypi.org/project/magpylib/>`_
93+
* `GitHub repository <https://github.com/magpylib/magpylib>`_

docs/_pages/9_physics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _physics&computation:
1+
.. _physComp:
22

33
***************************
44
[WIP] Physics & Computation

docs/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,7 @@ More examples can be found in the `Examples Section`__.
5555

5656
__ _pages/2_guideExamples/
5757

58-
Technical details can be found in the Documentation__.
59-
60-
__ _pages/0_documentation/
58+
Technical details can be found in the :ref:`docu` .
6159

6260

6361
.. toctree::

0 commit comments

Comments
 (0)