Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deleted gmsh, meshio dependencies. #267

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions dependencies/conda_env.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,14 @@ channels:
dependencies:
- python>=3.9
- cmake
- k3d
# - numpy=1.23 #Temporary error with numba calling numpy calling ufunc with no exceptions in latest numpy; see https://github.com/numba/numba/issues/8615
- vtk
- numpy
- jupyterlab
- yt
- scipy<=1.13
- mpi4py
- plotly
- pyyaml
- ipywidgets
- meshio=5.2
- tqdm
- palettable
- h5py
Expand All @@ -31,8 +28,11 @@ dependencies:
- pandas
- nodejs
- twine
- sphinx=4.4.0
- breathe
- sphinx #=4.4.0
- pip
- pip:
- breathe
# - breathe #install with pip, otherwise it will install the wrong version, not compatible with sphinx
- sphinx-copybutton
- nbsphinx
- sphinx_rtd_theme
Expand Down
13 changes: 4 additions & 9 deletions docs/src/0_getting_started/0_prerequisites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Below is a list of the software required to be able to compile and run Magritte.
* `GCC <https://gcc.gnu.org/>`_ (version :literal:`5.0.0` or later): to compile the C++ part of Magritte.
* `CMake <https://cmake.org/>`_ (version :literal:`3.18.0` or later): for building Magritte, organising compilation and linking;
* `Anaconda <https://www.anaconda.com/blog/individual-edition-2020-11>`_ (optional): for managing the required Python packages;
* `Gmsh <https://gmsh.info/>`_ (optional): for constructing geometric meshes for the models;
.. * `Gmsh <https://gmsh.info/>`_ (optional): for constructing geometric meshes for the models;

Although Anaconda is optional and you could, in priciple, use any other way of installing the required Python dependencies, we recommend and assume the use of Anaconda.
The list of required Python packages can be found in the `conda environment file <https://github.com/Magritte-code/Magritte/blob/stable/dependencies/conda_env.yml>`_.
Also Gmsh is optional, however, it will be used in most examples in this documentation to create models.
.. Also Gmsh is optional, however, it will be used in most examples in this documentation to create models.

Once these prerequisites are in place, Magritte can be installed following the :ref:`quickstart <link-quickstart>`.

Expand All @@ -25,9 +25,8 @@ Once these prerequisites are in place, Magritte can be installed following the :


.. Hint::
Although we recommend to first try to install the required software in your preferred usual way, the folder `Magritte/dependencies/ <https://github.com/Magritte-code/Magritte/tree/stable/dependencies>`_ contains a set of bash scripts: :literal:`get_conda.sh`, :literal:`get_cmake.sh`,
and :literal:`get_gmsh.sh`, to quickly obtain the appropriate versions of miniconda3 (for Anaconda), CMake, and
Gmsh respectively. However, these scripts don't properly install the software, but rather download an executable binary, which is useful, e.g. if you don't have root access.
Although we recommend to first try to install the required software in your preferred usual way, the folder `Magritte/dependencies/ <https://github.com/Magritte-code/Magritte/tree/stable/dependencies>`_ contains a set of bash scripts: :literal:`get_conda.sh` and :literal:`get_cmake.sh`,
to quickly obtain the appropriate versions of miniconda3 (for Anaconda) and CMake respectively. However, these scripts don't properly install the software, but rather download an executable binary, which is useful, e.g. if you don't have root access.

To use these, first clone the Magritte `GitHub <https://github.com/Magritte-code/Magritte>`_ repository

Expand All @@ -44,10 +43,6 @@ Once these prerequisites are in place, Magritte can be installed following the :
.. code-block:: shell

bash dependencies/get_cmake.sh

.. code-block:: shell

bash dependencies/get_gmsh.sh

⚠️ Don't forget to include the relevant paths to your shell's :literal:`$PATH` variable!
(For convenience, the scripts will print the relevant path.)
Expand Down
3 changes: 0 additions & 3 deletions docs/src/0_getting_started/2_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ Magritte has several dependencies, some of which are optional.
**Optional**

* `Anaconda <https://www.anaconda.com/blog/individual-edition-2020-11>`_, for managing the required Python packages;
* `Gmsh <https://gmsh.info/>`_, version :literal:`4.6.0` or later, for meshing model geometries.


Please note that :literal:`Paracabs` might have further dependencies depending
Expand All @@ -71,8 +70,6 @@ the model files.
* :mod:`scipy`, for interpolation and spatial functions such as nearest neighbour calculations;
* :mod:`healpy`, to sample directions from a discretized unit sphere;
* :mod:`astropy`, for unit conversions and physical constants;
* :mod:`meshio`, for reading and writing several types of mesh data structures;
* :mod:`vtk`, for reading and writing vtk files;
* :mod:`pyyaml`, for reading and writing yaml files;
* :mod:`mpi4py`, for MPI (Message Passing Interface) functionality in Python;
* :mod:`tqdm`, for progress bars;
Expand Down
Loading
Loading