DOLFINx helpers

A collection of helper functions for working with DOLFINx's Python interface and visualizing objects using Matplotlib.

This project is developed in collaboration with the Centre for Advanced Research Computing, University College London.

Documentation

Current members

Former members

Centre for Advanced Research Computing, University College London (arc.collaborations@ucl.ac.uk)

Compatible with Python 3.10 and above. We recommend DOLFINx v0.7.0 or above to be installed although we support v0.6.0 for now.

To install the latest development using pip run

pip install git+https://github.com/UCL/dxh.git

Alternatively create a local clone of the repository with

git clone https://github.com/UCL/dxh.git

and then install in editable mode by running

pip install -e .

from the root of your clone of the repository.

Tests can be run across all compatible Python versions in isolated environments using tox by running

tox

from the root of the repository, or to run tests with Python 3.10 specifically run

tox -e test-py310

substituting py310 for py311 or py312 to run tests with Python 3.11 or 3.12 respectively.

To run tests manually in a Python environment with pytest installed run

pytest tests

again from the root of the repository.

HTML documentation can be built locally using tox by running

tox -e docs

from the root of the repository with the output being written to docs/_build/html.

This work was funded by a grant from the the Engineering and Physical Sciences Research Council (EPSRC).