Use pip3 install --user pyprecice to install the python language bindings from PyPI
The versioning scheme
The versioning scheme of the python bindings is the preCICE version with the additional version of the python bindings.
Example: version 1 of the python bindings for preCICE version 2.2.0 is 2.2.0.1
Installation
The python bindings for preCICE are published on PyPI with the package pyprecice. You can use your python package manager for installing the language bindings. For example, pip3 install --user pyprecice. Note that preCICE and MPI have to be installed on your system.
Usage
The usage of the python language bindings for preCICE is very similar to the C++ API. Therefore, please refer to our section on coupling your code for getting started. Some important differences:
- Call
import preciceat the beginning of your script. - The object
precice.Interfaceis the main access point to the preCICE API. - We try to follow PEP8 with respect to function and class names. Meaning:
write_block_scalar_data, notwriteBlockScalarData, since this is a function call. - Please use
numpyarrays, if this seems appropriate. For scalar data a 1D-numpywithsizeentries should be used; for vector data a 2D-numpyarray withsize x dimensionsentries should be used. This allows us to drop thesizeargument some functions calls. Meaning: notwriteBlockScalarData (int dataID, int size, int* vertexIDs, double* values), butwrite_block_scalar_data(dataID, vertexIDs, values).
Tip: You can use Python’s
help() function for getting detailed usage information. Example: Open a python3 shell, import precice, help(precice.Interface) or help(precice.Interface.write_block_scalar_data)More details & troubleshooting
The python package and detailed documentation for the python bindings can be found here.