Skip to content

Commit 690477e

Browse files
committed
add meson in the documentation
1 parent 9b8593d commit 690477e

4 files changed

Lines changed: 14 additions & 10 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* **MagIC** uses either Chebyshev polynomials or finite differences in the radial direction and spherical harmonic decomposition in the azimuthal and latitudinal directions. MagIC supports several Implicit-Explicit time schemes where the nonlinear terms and the Coriolis force are treated explicitly, while the remaining linear terms are treated implicitly.
1414

1515

16-
* **MagIC** is written in Fortran and designed to be used on supercomputing clusters. It thus relies on a hybrid parallelisation scheme using both [OpenMP](https://openmp.org/wp/) and [MPI](https://www.open-mpi.org/). Postprocessing functions written in python (requiring [matplotlib](https://matplotlib.org/) and [scipy](https://www.scipy.org/) are also provided to allow a useful data analysis.
16+
* **MagIC** is written in Fortran and designed to be used on supercomputing clusters. It thus relies on a hybrid parallelisation scheme using both [OpenMP](https://openmp.org/wp/) and [MPI](https://www.open-mpi.org/). Postprocessing functions written in python (requiring [matplotlib](https://matplotlib.org/), [meson](https://mesonbuild.com/meson-python/) and [scipy](https://www.scipy.org/) are also provided to allow a useful data analysis.
1717

1818
* **MagIC** is a free software. It can be used, modified and redistributed under the terms of the [GNU GPL v3 licence](https://www.gnu.org/licenses/gpl-3.0.en.html).
1919

@@ -162,7 +162,7 @@ $ mpiexec -n 4 ./magic.exe input.nml
162162

163163
### 7) Data visualisation and postprocessing
164164

165-
a) Set-up your PYTHON environment ([ipython](https://ipython.org/), [scipy](https://www.scipy.org/) and [matplotlib](https://matplotlib.org/) are needed)
165+
a) Set-up your PYTHON environment ([ipython](https://ipython.org/), [scipy](https://www.scipy.org/), [meson](https://mesonbuild.com/meson-python/) and [matplotlib](https://matplotlib.org/) are needed)
166166

167167
b) Modify `magic.cfg` according to your machine in case the auto-configuration didn't work
168168

doc/sphinx/foreword.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ several Implicit-Explicit time schemes where the nonlinear terms and the Corioli
1717
**MagIC** is written in Fortran and designed to be used on supercomputing
1818
clusters. It thus relies on a hybrid parallelisation scheme using both `OpenMP
1919
<https://openmp.org/wp/>`_ and `MPI <https://www.open-mpi.org/>`_. Postprocessing
20-
functions written in python (requiring `matplotlib <https://matplotlib.org/>`_
21-
and `scipy <https://www.scipy.org/>`_) are also provided to allow a useful data
20+
functions written in python (requiring `matplotlib <https://matplotlib.org/>`_,
21+
`meson <https://mesonbuild.com/meson-python/>`_ and
22+
`scipy <https://www.scipy.org/>`_) are also provided to allow a useful data
2223
analysis.
2324

2425
.. figure:: figs/magic_occigen.png

doc/sphinx/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,10 @@ Welcome
4444

4545
**MagIC** is written in Fortran and designed to be used on supercomputing
4646
clusters. It thus relies on a hybrid parallelisation scheme using both `OpenMP
47-
<http://openmp.org/wp/>`_ and `MPI <http://www.open-mpi.org/>`_. Postprocessing
48-
functions written in python (requiring `matplotlib <http://matplotlib.org/>`_
49-
and `scipy <http://www.scipy.org/>`_) are also provided to allow a useful data
47+
<http://openmp.org/wp/>`_ and `MPI <https://www.open-mpi.org/>`_. Postprocessing
48+
functions written in python (requiring `matplotlib <https://matplotlib.org/>`_,
49+
`meson <https://mesonbuild.com/meson-python/>`_,
50+
and `scipy <https://www.scipy.org/>`_) are also provided to allow a useful data
5051
analysis.
5152

5253
.. figure:: figs/magic_occigen.png

doc/sphinx/postProc.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ Requirements
1414
Hard dependencies
1515
-----------------
1616

17-
* `python <https://www.python.org>`_ 2.7/3.3 or higher.
17+
* `python <https://www.python.org>`_ 3.3 or higher.
1818

19-
* `matplotlib <http://matplotlib.org>`_ 1.0 or higher.
19+
* `matplotlib <https://matplotlib.org>`_ 1.0 or higher.
2020

21-
* `scipy <http://www.scipy.org/>`_ 0.10 or higher.
21+
* `meson <https://mesonbuild.com/meson-python/>`_ 0.10 or higher.
22+
23+
* `scipy <https://www.scipy.org/>`_ 0.10 or higher.
2224

2325
Optional dependencies
2426
---------------------

0 commit comments

Comments
 (0)