{"id":26766154,"url":"https://github.com/ucl/dxh","last_synced_at":"2025-03-28T20:19:19.931Z","repository":{"id":180654670,"uuid":"665214899","full_name":"UCL/dxh","owner":"UCL","description":"Collection of helper functions for working with DOLFINx Python interface","archived":false,"fork":false,"pushed_at":"2024-04-22T11:28:48.000Z","size":8580,"stargazers_count":3,"open_issues_count":5,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-04-22T12:26:04.493Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://github-pages.ucl.ac.uk/dxh/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UCL.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-07-11T17:39:51.000Z","updated_at":"2024-04-22T12:26:05.547Z","dependencies_parsed_at":"2023-10-22T16:27:07.293Z","dependency_job_id":null,"html_url":"https://github.com/UCL/dxh","commit_stats":null,"previous_names":["ucl/dxh"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UCL%2Fdxh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UCL%2Fdxh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UCL%2Fdxh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UCL%2Fdxh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UCL","download_url":"https://codeload.github.com/UCL/dxh/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246093166,"owners_count":20722403,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-28T20:19:19.257Z","updated_at":"2025-03-28T20:19:19.893Z","avatar_url":"https://github.com/UCL.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DOLFINx helpers\n\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![Tests](https://github.com/UCL/dxh/actions/workflows/tests.yml/badge.svg)](https://github.com/UCL/dxh/actions/workflows/tests.yml)\n[![codecov](https://codecov.io/gh/UCL/dxh/graph/badge.svg?token=z0y0mDsvIx)](https://codecov.io/gh/UCL/dxh)\n[![Linting](https://github.com/UCL/dxh/actions/workflows/linting.yml/badge.svg)](https://github.com/UCL/dxh/actions/workflows/linting.yml)\n[![Documentation](https://github.com/UCL/dxh/actions/workflows/docs.yml/badge.svg)](https://github-pages.ucl.ac.uk/dxh/)\n[![Licence][licence-badge]](./LICENCE.md)\n\n\u003c!--\n[![PyPI version][pypi-version]][pypi-link]\n[![Conda-Forge][conda-badge]][conda-link]\n[![PyPI platforms][pypi-platforms]][pypi-link]\n--\u003e\n\n\u003c!-- prettier-ignore-start --\u003e\n[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/dxh\n[conda-link]:               https://github.com/conda-forge/dxh-feedstock\n[pypi-link]:                https://pypi.org/project/dxh/\n[pypi-platforms]:           https://img.shields.io/pypi/pyversions/dxh\n[pypi-version]:             https://img.shields.io/pypi/v/dxh\n[licence-badge]:             https://img.shields.io/badge/License-MIT-yellow.svg\n\u003c!-- prettier-ignore-end --\u003e\n\nA collection of helper functions for working with [DOLFINx's Python interface](https://docs.fenicsproject.org/dolfinx/main/python/)\nand visualizing objects using [Matplotlib](https://matplotlib.org/).\n\nThis project is developed in collaboration with the [Centre for Advanced Research Computing](https://ucl.ac.uk/arc), University College London.\n\n## Documentation\n\nDocumentation can be viewed at https://github-pages.ucl.ac.uk/dxh/\n\n## About\n\n### Project team\n\nCurrent members\n\n- Erik Burman ([burmanerik](https://github.com/burmanerik))\n- Sam Cunliffe ([samcunliffe](https://github.com/samcunliffe))\n- Deepika Garg ([deepikagarg20](https://github.com/deepikagarg20))\n- Krishnakumar Gopalakrishnan ([krishnakumarg1984](https://github.com/krishnakumarg1984))\n- Matt Graham ([matt-graham](https://github.com/matt-graham))\n- Janosch Preuss ([janoschpreuss](https://github.com/janoschpreuss))\n\nFormer members\n\n- Anastasis Georgoulas ([ageorgou](https://github.com/ageorgou))\n- Jamie Quinn ([JamieJQuinn](https://github.com/JamieJQuinn))\n\n### Research software engineering contact\n\nCentre for Advanced Research Computing, University College London\n([arc.collaborations@ucl.ac.uk](mailto:arc.collaborations@ucl.ac.uk))\n\n## Built with\n\n- [FEniCSx](https://fenicsproject.org/)\n- [Matplotlib](https://matplotlib.org/)\n- [NumPy](https://numpy.org/)\n\n## Getting started\n\n### Prerequisites\n\nCompatible with Python 3.10 and above.\n[We recommend DOLFINx v0.7.0 or above to be installed](https://github.com/FEniCS/dolfinx#installation) although we support v0.6.0 for now.\n\n### Installation\n\nTo install the latest development using `pip` run\n\n```sh\npip install git+https://github.com/UCL/dxh.git\n```\n\nAlternatively create a local clone of the repository with\n\n```sh\ngit clone https://github.com/UCL/dxh.git\n```\n\nand then install in editable mode by running\n\n```sh\npip install -e .\n```\n\nfrom the root of your clone of the repository.\n\n### Running tests\n\nTests can be run across all compatible Python versions in isolated environments using\n[`tox`](https://tox.wiki/en/latest/) by running\n\n```sh\ntox\n```\n\nfrom the root of the repository, or to run tests with Python 3.10 specifically run\n\n```sh\ntox -e test-py310\n```\n\nsubstituting `py310` for `py311` or `py312` to run tests with Python 3.11 or 3.12 respectively.\n\nTo run tests manually in a Python environment with `pytest` installed run\n\n```sh\npytest tests\n```\n\nagain from the root of the repository.\n\n### Building documentation\n\nHTML documentation can be built locally using `tox` by running\n\n```sh\ntox -e docs\n```\n\nfrom the root of the repository with the output being written to `docs/_build/html`.\n\n## Acknowledgements\n\nThis work was funded by a grant from the the Engineering and Physical Sciences Research Council (EPSRC).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fucl%2Fdxh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fucl%2Fdxh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fucl%2Fdxh/lists"}