Skip to content
README.rst 1.48 KiB
Newer Older
Andreas Klöckner's avatar
Andreas Klöckner committed
grudge
======

.. image:: https://gitlab.tiker.net/inducer/grudge/badges/main/pipeline.svg
Andreas Klöckner's avatar
Andreas Klöckner committed
    :alt: Gitlab Build Status
    :target: https://gitlab.tiker.net/inducer/grudge/commits/main
.. image:: https://github.com/inducer/grudge/workflows/CI/badge.svg?branch=main&event=push
Andreas Klöckner's avatar
Andreas Klöckner committed
    :alt: Github Build Status
    :target: https://github.com/inducer/grudge/actions?query=branch%3Amain+workflow%3ACI+event%3Apush
Andreas Klöckner's avatar
Andreas Klöckner committed

..
    .. image:: https://badge.fury.io/py/grudge.png
        :alt: Python Package Index Release Page
        :target: https://pypi.org/project/grudge/

Andreas Klöckner's avatar
Andreas Klöckner committed
grudge helps you discretize discontinuous Galerkin operators, quickly
and accurately.

It relies on

Andreas Klöckner's avatar
Andreas Klöckner committed
* `numpy <https://pypi.org/project/numpy>`_ for arrays
* `modepy <https://pypi.org/project/modepy>`_ for modes and nodes on simplices
* `meshmode <https://pypi.org/project/meshmode>`_ for modes and nodes on simplices
* `loopy <https://pypi.org/project/loopy>`_ for fast array operations
* `pytest <https://pypi.org/project/pytest>`_ for automated testing
Andreas Klöckner's avatar
Andreas Klöckner committed

and, indirectly,

Andreas Klöckner's avatar
Andreas Klöckner committed
* `PyOpenCL <https://pypi.org/project/pyopencl>`_ as computational infrastructure
Andreas Klöckner's avatar
Andreas Klöckner committed

PyOpenCL is likely the only package you'll have to install
by hand, all the others will be installed automatically.

.. image:: https://badge.fury.io/py/grudge.png
Andreas Klöckner's avatar
Andreas Klöckner committed
    :target: https://pypi..org/project/grudge
Andreas Klöckner's avatar
Andreas Klöckner committed

Resources:

Andreas Klöckner's avatar
Andreas Klöckner committed
* `documentation <https://documen.tician.de/grudge>`_
* `wiki home page <https://wiki.tiker.net/Grudge>`_
* `source code via git <https://gitlab.tiker.net/inducer/grudge>`_