Metadata-Version: 2.1
Name: coffeegrinder
Version: 0.3.4
Summary: COFFEE is an MPI-Parallelised Python package for the numerical evolution of time-dependent differential equations.
Home-page: https://github.com/coffee-gr/coffee
Author: Chris Stevens
Author-email: chris.stevens@canterbury.ac.nz
License: MIT
Project-URL: Documentation, https://pyscaffold.org/
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Description-Content-Type: text/x-rst; charset=UTF-8
License-File: LICENSE.txt
Requires-Dist: importlib-metadata; python_version < "3.8"
Requires-Dist: numpy
Requires-Dist: h5py
Requires-Dist: scipy
Requires-Dist: matplotlib
Provides-Extra: mpi
Requires-Dist: mpi4py; extra == "mpi"
Provides-Extra: jax
Requires-Dist: jax; extra == "jax"
Requires-Dist: jaxlib; extra == "jax"
Provides-Extra: mpi-jax
Requires-Dist: mpi4py; extra == "mpi-jax"
Requires-Dist: jax; extra == "mpi-jax"
Requires-Dist: jaxlib; extra == "mpi-jax"
Provides-Extra: testing
Requires-Dist: setuptools; extra == "testing"
Requires-Dist: pytest; extra == "testing"
Requires-Dist: pytest-cov; extra == "testing"

.. These are examples of badges you might want to add to your README:
   please update the URLs accordingly

    .. image:: https://api.cirrus-ci.com/github/<USER>/coffee.svg?branch=main
        :alt: Built Status
        :target: https://cirrus-ci.com/github/<USER>/coffee
    .. image:: https://readthedocs.org/projects/coffee/badge/?version=latest
        :alt: ReadTheDocs
        :target: https://coffee.readthedocs.io/en/stable/
    .. image:: https://img.shields.io/coveralls/github/<USER>/coffee/main.svg
        :alt: Coveralls
        :target: https://coveralls.io/r/<USER>/coffee
    .. image:: https://img.shields.io/pypi/v/coffee.svg
        :alt: PyPI-Server
        :target: https://pypi.org/project/coffee/
    .. image:: https://img.shields.io/conda/vn/conda-forge/coffee.svg
        :alt: Conda-Forge
        :target: https://anaconda.org/conda-forge/coffee
    .. image:: https://pepy.tech/badge/coffee/month
        :alt: Monthly Downloads
        :target: https://pepy.tech/project/coffee
    .. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter
        :alt: Twitter
        :target: https://twitter.com/coffee

.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
    :alt: Project generated with PyScaffold
    :target: https://pyscaffold.org/
.. image:: https://readthedocs.org/projects/coffee-gr/badge/?version=latest
    :target: https://coffee-gr.readthedocs.io/en/latest/?badge=latest
    :alt: 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.

.. _pyscaffold-notes:

Note
====

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