Skip to content
/ dxh Public

Collection of helper functions for working with DOLFINx Python interface

License

Notifications You must be signed in to change notification settings

UCL/dxh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DOLFINx helpers

pre-commit Tests codecov Linting Documentation Licence

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

Documentation can be viewed at https://github-pages.ucl.ac.uk/dxh/

About

Project team

Current members

Former members

Research software engineering contact

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

Built with

Getting started

Prerequisites

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.

Installation

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.

Running tests

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.

Building documentation

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.

Acknowledgements

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

About

Collection of helper functions for working with DOLFINx Python interface

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages