Skip to content

Commit dcd6cf2

Browse files
committed
update readme
1 parent e489279 commit dcd6cf2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Getting started
2323

2424
The code is hosted on GitHub, see `https://github.com/Parallel-in-Time/pySDC <https://github.com/Parallel-in-Time/pySDC>`_, and PyPI, see `https://pypi.python.org/pypi/pySDC <https://pypi.python.org/pypi/pySDC>`_.
2525
Either use ``pip install pySDC`` to get the latest stable release including the core dependencies or check out the code on Github.
26-
Note that using ``pip install pySDC`` or ``python setup.py install`` will only install the core dependencies, omitting `mpi4py` and `petsc4py` (see below).
26+
Note that using ``pip install pySDC`` or ``python setup.py install`` will only install the core dependencies, omitting e.g. `mpi4py`, 'fenics` and `petsc4py` (see below).
2727
All package requirements are listed in the files `requirements.txt <https://github.com/Parallel-in-Time/pySDC/blob/master/requirements.txt>`_ .
2828

2929
To check your installation, run
@@ -41,16 +41,16 @@ You may need to update your ``PYTHONPATH`` by running
4141
in particular if you want to run any of the playgrounds, projects or tutorials.
4242
All ``import`` statements there assume that the `pySDC`'s base directory is part of ``PYTHONPATH``.
4343

44-
Note: When installing both `mpi4py` and `petsc4py`, make sure they use the same MPI installation (e.g. MPICH3).
44+
Note: When installing `mpi4py`, `fenics` and `petsc4py`, make sure they use the same MPI installation (e.g. MPICH3).
4545
You can achieve this e.g. by using the `Anaconda distribution <https://www.anaconda.com/distribution/>`_ of Python and then run
4646

4747
.. code-block:: bash
4848
49-
conda install -c conda-forge mpich petsc4py mpi4py
49+
conda install -c conda-forge mpich petsc4py mpi4py fenics
5050
5151
Most of the code is tested automatically using `Travis-CI <https://travis-ci.org/Parallel-in-Time/pySDC>`_, so a working version of the installation process can always be found in the `install`-block of the `.travis.yml <https://github.com/Parallel-in-Time/pySDC/blob/master/.travis.yml>`_ file.
5252

5353
For many examples, `LaTeX` is used for the plots, i.e. a decent installation of this is needed in order to run the tests.
54-
When using `FEniCS` or `petsc4py`, a C++ compiler is required (although installation may go through at first).
54+
When using `fenics` or `petsc4py`, a C++ compiler is required (although installation may go through at first).
5555

5656
For more details on `pySDC`, check out `http://www.parallel-in-time.org/pySDC <http://www.parallel-in-time.org/pySDC>`_.

0 commit comments

Comments
 (0)