Project generated with PyScaffold Documentation Status

COFFEE

COFFEE is an MPI-Parallelised Python package for the numerical evolution of time-dependent differential equations.

Installation

There are four versions of COFFEE, which can include MPI and/or JAX capabilities. These can be installed via

pip install coffeegrinder

pip install coffeegrinder[MPI]

pip install coffeegrinder[JAX]

pip install coffeegrinder[MPI-JAX]

Getting started

There is a systems directory that includes commented test cases for the 1D advection equation with a mixture of finite-differencing operators and boundary imposition methods.

Note

This project has been set up using PyScaffold 4.4. For details and usage information on PyScaffold see https://pyscaffold.org/.