Python language bindings for the C++ library preCICE

⚠️ The latest version of the documentation for the python bindings can be found on precice.org. The information from this README is currently under revision and will be moved ⚠️

This package provides python language bindings for the C++ library preCICE. Note that the first two digits of the version number of the bindings indicate the major and minor version of the preCICE version that the bindings support. The last digit represents the version of the bindings. Example: v3.1.0 and v3.1.1 of the bindings represent versions 0 and 1 of the bindings that are compatible with preCICE v3.1.x. Note that this versioning scheme was introduced from bindings v3.1.0, which is different than the old versioning scheme.

User documentation

Please refer to the preCICE documentation for information on how to install and use the python bindings. Information below is intended for advanced users and developers.

Required dependencies

preCICE: Refer to the preCICE documentation for information on building and installation.

C++: A working C++ compiler, e.g., g++.

MPI: mpi4py requires MPI to be installed on your system.

Installing the package

We recommend using pip3 (version 19.0.0 or newer required) for the sake of simplicity. You can check your pip3 version via pip3 --version. To update pip3, use the following line:

$ pip3 install --user --upgrade pip

Using pip3

preCICE system installs

For system installs of preCICE, installation works out of the box. There are different ways how pip can be used to install pyprecice. pip will fetch cython and other build-time dependencies, compile the bindings and finally install the package pyprecice.

• (recommended) install pyprecice from PyPI

  $ pip3 install --user pyprecice
  

• provide the link to this repository to pip (replace `` with the branch you want to use, preferably master or develop)

  $ pip3 install --user https://github.com/precice/python-bindings/archive/.zip
  

• if you already cloned this repository, execute the following command from this directory:

  $ pip3 install --user .
  

  note the dot at the end of the line

preCICE at custom location (setting PATHS)

If preCICE (the C++ library) was installed in a custom prefix, or only built but not installed at all, you have to extend the following environment variables:

• LIBRARY_PATH, LD_LIBRARY_PATH to the library location, or $prefix/lib
• CPATH either to the src directory or the $prefix/include

The preCICE documentation provides more informaiton on linking preCICE.

Using Spack

You can also install the python language bindings for preCICE via Spack by installing the Spack package py-pyprecice. Refer to our installation guide for preCICE via Spack for getting started with Spack.

Using setup.py

preCICE system installs

In this directory, execute:

$ python3 setup.py install --user

preCICE at custom location (setting PATHS)

see above. Then run

$ python3 setup.py install --user

preCICE at custom location (explicit include path, library path)

1. Install cython and other dependencies via pip3

   $ pip3 install --user setuptools wheel cython packaging numpy
   

2. Open terminal in this folder.

3. Build the bindings

   $ python3 setup.py build_ext --include-dirs=$PRECICE_ROOT/src --library-dirs=$PRECICE_ROOT/build/last
   

   Options:

   • --include-dirs=, default: '' Path to the headers of preCICE, point to the sources $PRECICE_ROOT/src, or the your custom install prefix $prefix/include.

   NOTES:

   • If you have built preCICE using CMake, you can pass the path to the CMake binary directory using --library-dirs.
   • It is recommended to use preCICE as a shared library here.

4. Install the bindings

   $ python3 setup.py install --user
   

5. Clean-up optional

   $ python3 setup.py clean --all
   

Test the installation

Update LD_LIBRARY_PATH such that python can find precice.so

$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PRECICE_ROOT/build/last

Run the following to test the installation:

$ python3 -c "import precice"

Unit tests

1. Clean-up mandatory (because we must not link against the real precice.so, but we use a mocked version)

   $ python3 setup.py clean --all
   

2. Set CPLUS_INCLUDE_PATH (we cannot use build_ext and the --include-dirs option here)

   $ export CPLUS_INCLUDE_PATH=$CPLUS_INCLUDE_PATH:$PRECICE_ROOT/src
   

3. Run tests with

   $ python3 setup.py test
   

Usage

You can find the documentation of the implemented interface in the file precice.pyx. For an example of how pyprecice can be used please refer to the 1D elastic tube example.

Note The python package that is installed is called pyprecice. It provides the python module precice that can be use in your code via import precice, for example.

Troubleshooting & miscellaneous

preCICE is not found

The following error shows up during installation, if preCICE is not found:

  /tmp/pip-install-d_fjyo1h/pyprecice/precice.cpp:643:10: fatal error: precice/Participant.hpp: No such file or directory
    643 | #include "precice/Participant.hpp"
        |          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  compilation terminated.
  error: command 'x86_64-linux-gnu-gcc' failed with exit status 1
  ----------------------------------------
  ERROR: Failed building wheel for pyprecice
Failed to build pyprecice
ERROR: Could not build wheels for pyprecice which use PEP 517 and cannot be installed directly

Or, for preCICE v2:

  /tmp/pip-install-d_fjyo1h/pyprecice/precice.cpp:643:10: fatal error: precice/SolverInterface.hpp: No such file or directory
    643 | #include "precice/SolverInterface.hpp"
        |          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  compilation terminated.
  error: command 'x86_64-linux-gnu-gcc' failed with exit status 1
  ----------------------------------------
  ERROR: Failed building wheel for pyprecice
Failed to build pyprecice
ERROR: Could not build wheels for pyprecice which use PEP 517 and cannot be installed directly

There are two possible reasons, why preCICE is not found:

1. preCICE is not installed. Please download and install the C++ library preCICE. See above.
2. preCICE is installed, but cannot be found. Please make sure that preCICE can be found during the installation process. See our wiki page on linking to preCICE and the instructions above.

Version of Cython is too old

In case the compilation fails with shared_ptr.pxd not found messages, check if you use the latest version of Cython.

Python.h missing

$ python3 -m pip install pyprecice
Collecting pyprecice
...
  /tmp/pip-build-7rj4_h93/pyprecice/precice.cpp:25:20: fatal error: Python.h: No such file or directory
  compilation terminated.
  error: command 'x86_64-linux-gnu-gcc' failed with exit status 1

  ----------------------------------------
  Failed building wheel for pyprecice

Please try to install python3-dev. E.g. via apt install python3-dev. Please make sure that you use the correct version (e.g. python3.5-dev or python3.6-dev). You can check your version via python3 --version.

libprecice.so is not found at runtime

$ python3 -c "import precice"
Traceback (most recent call last):
  File "", line 1, in 
ImportError: libprecice.so.2: cannot open shared object file: No such file or directory

Make sure that your LD_LIBRARY_PATH includes the directory that contains libprecice.so. The actual path depends on how you installed preCICE. Example: If preCICE was installed using sudo make install and you did not define a CMAKE_INSTALL_PREFIX the library path is /usr/local/lib. This means you have to export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH.

I'm using preCICE < 2.0.0, but there is no matching version of the bindings. What can I do?

If you want to use the old experimental python bindings (released with preCICE version < 2.0.0), please refer to the corresponding preCICE version. Example: for preCICE v1.6.1 there are three different versions of the python bindings: precice_future, precice and PySolverInterface. Installation instructions can be found in the corresponding README files.

Installing the python bindings for Python 2.7.17

Note that the instructions in this section are outdated and refer to the deprecated python bindings. Until we have updated information on the installation procedure for the python bindings under this use-case, we will keep these instructions, since they might still be very useful (Originally contributed by huangq1234553 to the precice wiki in precice/precice/wiki:8bb74b7.)

module load gcc/7
module unload mpi.intel
module load mpi.intel/2018_gcc
module load cmake/3.12.1

mkdir build && cd build
cmake -DBUILD_SHARED_LIBS=ON -DPRECICE_FEATURE_PETSC_MAPPING=OFF -DPRECICE_FEATURE_PYTHON_ACTIONS=ON -DCMAKE_INSTALL_PREFIX=/path/to/precice -DCMAKE_BUILD_TYPE=Debug .. -DPYTHON_INCLUDE_DIR=$(python -c "from distutils.sysconfig import get_python_inc; print(get_python_inc())")  -DPYTHON_LIBRARY=$(python -c "import distutils.sysconfig as sysconfig; print(sysconfig.get_config_var('LIBDIR')+'/libpython2.7.so')") -DNumPy_INCLUDE_DIR=$(python -c "import numpy; print(numpy.get_include())")
make -j 12
make install

export PRECICE_ROOT="path/to/precice_install"
export PKG_CONFIG_PATH="path/to/precice_install/lib/pkgconfig:${PKG_CONFIG_PATH}"
export CPLUS_INCLUDE_PATH="path/to/precice_install/include:${CPLUS_INCLUDE_PATH}"
export LD_LIBRARY_PATH="path/to/precice_install/lib:${LD_LIBRARY_PATH}"

cd /path/to/precice/src/precice/bindings/python_future

from __future__ import (absolute_import, division,
                        print_function)
from builtins import (
         bytes, dict, int, list, object, range, str,
         ascii, chr, hex, input, next, oct, open,
         pow, round, super,
         filter, map, zip)

python setup.py install --user

ValueError while importing preCICE

If you face the error:

ValueError: numpy.ndarray size changed, may indicate binary incompatibility. Expected 88 from C header, got 80 from PyObject

make sure that you are using an up-to-date version of NumPy. You can update NumPy with

pip3 install numpy --upgrade

Old versioning scheme

Bindings versions up to v3.0.0.0 have four digits, where the first three digits are the supported preCICE version, and the fourth digit is the bindings version. Example: v2.0.0.1 and v2.0.0.2 of the bindings represent versions 1 and 2 of the bindings that are compatible with preCICE v2.0.0. We dropped the third digit of the preCICE version as bugfix releases are always compatible and do not impact the bindings. The new three digit format is now consistent with other preCICE bindings.

Contributors

• Benjamin Rodenberg
• Ishaan Desai
• Saumitra Vinay Joshi contributed first working prototype in 3db9c9 on precice/precice
• Frédéric Simonis
• Florian Lindner
• Benjamin Uekermann
• Gerasimos Chourdakis