Skip to content

Commit b227da6

Browse files
committed
pushing new version
1 parent 11480c9 commit b227da6

File tree

4 files changed

+21
-10
lines changed

4 files changed

+21
-10
lines changed

CHANGELOG.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Changelog
22
---------
33

44
- August 30, 2019: Version 3.1 adds many more examples like the nonlinear Schrödinger equation, more on Gray-Scott and in particular Allen-Cahn.
5-
Those are many implemented using the parallel FFT library `mpi4pi-fft <https://bitbucket.org/mpi4py/mpi4py-fft/src/master/>`_, which can now be used with pySDC.
6-
There are now 8 tutorials, where step 7 shows the usage of three external libraries with pySDC: mpi4py, FEniCS and petsc4py.
5+
Those are many implemented using the parallel FFT library `mpi4pi-fft <https://bitbucket.org/mpi4py/mpi4py-fft/src/master/>`_, which can now be used with `pySDC`.
6+
There are now 8 tutorials, where step 7 shows the usage of three external libraries with `pySDC`: mpi4py, FEniCS and petsc4py.
77
The MPI controller has been improved after performaning a detailed performance analysis using `Score-P <https://www.vi-hps.org/projects/score-p/>`_ and `Extrae <https://www.vi-hps.org/Tools/Extrae.html>`_.
88
Finally: first steps towards error/iteration estimators are taken, too.
99

README.rst

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Features
1010

1111
- Variants of SDC: explicit, implicit, IMEX, multi-implicit, Verlet, multi-level, diagonal, multi-step
1212
- Variants of PFASST: virtual parallel or MPI-based parallel, classical of multigrid perspective
13-
- 7 tutorials: from setting up a first collocation problem to SDC, PFASST and advanced topics
13+
- 8 tutorials: from setting up a first collocation problem to SDC, PFASST and advanced topics
1414
- Projects: many documented projects with defined and tested outcomes
1515
- Many different examples, collocation types, data types already implemented
1616
- Works with `PETSc <http://www.mcs.anl.gov/petsc/>`_ through `petsc4py <https://bitbucket.org/petsc/petsc4py>`_ , `FEniCS <https://fenicsproject.org/>`_ and `mpi4py-fft <https://mpi4py-fft.readthedocs.io/en/latest/>`_
@@ -22,9 +22,20 @@ Getting started
2222
---------------
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>`_.
25-
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 e.g. `mpi4py`, `fenics` and `petsc4py` (see below).
27-
All package requirements are listed in the files `requirements.txt <https://github.com/Parallel-in-Time/pySDC/blob/master/requirements.txt>`_ .
25+
Use
26+
27+
.. code-block:: bash
28+
29+
pip install pySDC
30+
31+
to get the latest stable release including the core dependencies.
32+
Note that this will omit some of the more complex packages not required for the core functionality of `pySDC`, e.g. `mpi4py`, `fenics` and `petsc4py` (see below).
33+
All requirements are listed in the files `requirements.txt <https://github.com/Parallel-in-Time/pySDC/blob/master/requirements.txt>`_ .
34+
To work with the source files, checkout the code from Github and install the dependencies e.g. by using a `conda <https://conda.io/en/latest/>`_ environment and
35+
36+
.. code-block:: bash
37+
38+
conda install -c conda-forge --file requirements.txt
2839
2940
To check your installation, run
3041

@@ -36,13 +47,13 @@ You may need to update your ``PYTHONPATH`` by running
3647

3748
.. code-block:: bash
3849
39-
export PYTHONPATH=$PYTHONPATH:../../..
50+
export PYTHONPATH=$PYTHONPATH:/path/to/pySDC/root/folder
4051
4152
in particular if you want to run any of the playgrounds, projects or tutorials.
4253
All ``import`` statements there assume that the `pySDC`'s base directory is part of ``PYTHONPATH``.
4354

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

4758
.. code-block:: bash
4859

pySDC/projects/FEniCS/__init__.py

Whitespace-only changes.

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setup(
77
name='pySDC',
8-
version='3.0',
8+
version='3.1',
99
description='A Python implementation of spectral deferred correction methods and the likes',
1010
license="BSD-2",
1111
long_description=long_description,
@@ -20,7 +20,7 @@
2020

2121
install_requires=[
2222
'nose>=1.3.7',
23-
'numpy>=1.9.3',
23+
'numpy>=1.15.4',
2424
'scipy>=0.17.1',
2525
'matplotlib>=1.5.3',
2626
'pep8',

0 commit comments

Comments
 (0)