Setup and Installation

Setup and Installation#

Install pystencils#

There are two ways to install the latest development version of pystencils 2.0. You can either install it directly from our git repository:

pip install "git+https://i10git.cs.fau.de/pycodegen/pystencils.git@v2.0-dev"

Or clone the repository locally and perform an editable install:

git clone -b v2.0-dev https://i10git.cs.fau.de/pycodegen/pystencils.git
pip install -e pystencils

Feature Groups#

In both cases, you can add a set of optional features to your installation by listing them in square brackets (e.g. pip install -e pystencils[feature1, feature2]). The following feature sets are available:

  • interactive (recommended): Install dependencies for using pystencils interactively from within Jupyter notebooks. Setting this flag will cause pip to install jupyter, matplotlib, and graphviz, among others, alongside pystencils.

  • alltrafos (recommended): Install dependencies to enable a wider set of code transformation. These include islpy for polyhedral loop transformations, and py-cpuinfo for detecting the current hardware in order to select optimal vector instructions.

  • use_cython: Install Cython, which is used internally by pystencils to accelerate the setup of boundary conditions.

For GPUs#

If you have an Nvidia graphics processor and CUDA installed, you can use pystencils to directly compile and execute kernels running on your GPU. This requires a working installation of Cupy. Please refer to the cupy’s installation manual for details about installing cupy.

You can also use Cupy together with AMD ROCm and HIP for AMD graphics cards, but the setup steps are a bit more complicated - you might have to build cupy from source. The Cupy documentation covers this in their installation guide for Cupy on ROCm.

Note

Since Cupy’s support for ROCm is at this time still an experimental feature, just-in-time compilation of pystencils HIP kernels for the ROCm platform must also considered experimental.

Contents