| Name | pyvista4dolfinx JSON |
| Version |
0.9.2
JSON |
| download |
| home_page | None |
| Summary | Re-introduction of a simple plot function for Dolfinx. |
| upload_time | 2025-07-09 08:36:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
dolfinx
fenicsx
pyvista
plotting
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyvista4dolfinx
[](https://gitlab.com/Stein.Stoter/pyvista4dolfinx/-/commits/main)
[](https://fenicsx4flow.gitlab.io/pyvista4dolfinx/coverage)
[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/pyvista4dolfinx/) <!--[](https://pepy.tech/project/pyvista4dolfinx/)-->
[](https://fenicsx4flow.gitlab.io/pyvista4dolfinx)
[](https://github.com/psf/black)
Re-introduction of a simple `plot` function for [Dolfinx](https://www.fenicsproject.org/). Documentation can be found [here](https://fenicsx4flow.gitlab.io/pyvista4dolfinx).
## Description
FEniCSx' design principles prioritize parallel efficiency, and (in an effort to avoid opaque performance pitfalls) favor fine-grained control over a high-level interface. Consequently, simple, general-purpose plotting routines are no-longer in the standard library. Instead users are deferred to ``pyvista`` for their plotting needs. Unfortunately, quite a bit of boiler-plate code is required to interface ``dolfinx`` and ``pyvista``. At a prototyping stage one often desires quick-and-dirty visualization with a *simple* interface. To facilitate this, ``pyvista4dolfinx`` provides a single ``plot`` function that can be used to plot most of ``dolfinx`` visualizable data-structures; scalar- and vector-valued ``Function``, ``Mesh``, ``FacetMarker``, and even integration ``Measure``. The function returns a ``pyvista.Plotter`` instance, such that the user still has full access to ``pyvista``'s full range of capabilities.
## Installation
This library is available through PyPi, to install simply run the following commands:
```bash
pip install pyvista4dolfinx
```
## Contributing
Feel free to make requests through opening an `issue`, or, better yet, if you want to contribute directly:
1. Fork the project.
2. Create a new branch (git checkout -b feature/my-feature).
3. Add your new feature or bugfix.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature/my-feature).
6. Open a merge request.
## To publish:
1. Bump version number in pyproject toml
2. Create git tag (`git tag <new_tag>`)
3. Push tag (`git push origin --tags`)
Raw data
{
"_id": null,
"home_page": null,
"name": "pyvista4dolfinx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"Stein K.F. Stoter\" <k.f.s.stoter@tue.nl>",
"keywords": "dolfinx, FEniCSx, pyvista, plotting",
"author": null,
"author_email": "\"Stein K.F. Stoter\" <k.f.s.stoter@tue.nl>",
"download_url": "https://files.pythonhosted.org/packages/4a/e4/981d3626abea0da471189d191ca0b53a4af05176a85415bb94654d1d4086/pyvista4dolfinx-0.9.2.tar.gz",
"platform": null,
"description": "# pyvista4dolfinx\n\n[](https://gitlab.com/Stein.Stoter/pyvista4dolfinx/-/commits/main)\n[](https://fenicsx4flow.gitlab.io/pyvista4dolfinx/coverage)\n[](https://opensource.org/licenses/MIT)\n[](https://pypi.org/project/pyvista4dolfinx/) <!--[](https://pepy.tech/project/pyvista4dolfinx/)-->\n[](https://fenicsx4flow.gitlab.io/pyvista4dolfinx)\n[](https://github.com/psf/black)\n\nRe-introduction of a simple `plot` function for [Dolfinx](https://www.fenicsproject.org/). Documentation can be found [here](https://fenicsx4flow.gitlab.io/pyvista4dolfinx).\n\n## Description\n\nFEniCSx' design principles prioritize parallel efficiency, and (in an effort to avoid opaque performance pitfalls) favor fine-grained control over a high-level interface. Consequently, simple, general-purpose plotting routines are no-longer in the standard library. Instead users are deferred to ``pyvista`` for their plotting needs. Unfortunately, quite a bit of boiler-plate code is required to interface ``dolfinx`` and ``pyvista``. At a prototyping stage one often desires quick-and-dirty visualization with a *simple* interface. To facilitate this, ``pyvista4dolfinx`` provides a single ``plot`` function that can be used to plot most of ``dolfinx`` visualizable data-structures; scalar- and vector-valued ``Function``, ``Mesh``, ``FacetMarker``, and even integration ``Measure``. The function returns a ``pyvista.Plotter`` instance, such that the user still has full access to ``pyvista``'s full range of capabilities.\n\n## Installation\n\nThis library is available through PyPi, to install simply run the following commands:\n\n```bash\npip install pyvista4dolfinx\n```\n\n## Contributing\nFeel free to make requests through opening an `issue`, or, better yet, if you want to contribute directly:\n\n1. Fork the project.\n2. Create a new branch (git checkout -b feature/my-feature).\n3. Add your new feature or bugfix.\n4. Commit your changes (git commit -m 'Add some feature').\n5. Push to the branch (git push origin feature/my-feature).\n6. Open a merge request.\n\n## To publish:\n\n1. Bump version number in pyproject toml\n2. Create git tag (`git tag <new_tag>`)\n3. Push tag (`git push origin --tags`)\n",
"bugtrack_url": null,
"license": null,
"summary": "Re-introduction of a simple plot function for Dolfinx.",
"version": "0.9.2",
"project_urls": {
"Documentation": "https://fenicsx4flow.gitlab.io/pyvista4dolfinx",
"Repository": "https://gitlab.com/fenicsx4flow/pyvista4dolfinx"
},
"split_keywords": [
"dolfinx",
" fenicsx",
" pyvista",
" plotting"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "94f21ebaa3b09dfe09cdadfa4438cf6cdbc98cf8135f9ade2045bc8f4fa79619",
"md5": "9cdb314c3307e37f67cd01e4a5e4fc55",
"sha256": "abdd4a5789abbcd48d154e0faba0e56ce4bacce34b3a2d032d7c6ebd4f9e9673"
},
"downloads": -1,
"filename": "pyvista4dolfinx-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9cdb314c3307e37f67cd01e4a5e4fc55",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10994,
"upload_time": "2025-07-09T08:36:36",
"upload_time_iso_8601": "2025-07-09T08:36:36.277862Z",
"url": "https://files.pythonhosted.org/packages/94/f2/1ebaa3b09dfe09cdadfa4438cf6cdbc98cf8135f9ade2045bc8f4fa79619/pyvista4dolfinx-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4ae4981d3626abea0da471189d191ca0b53a4af05176a85415bb94654d1d4086",
"md5": "5550b7464c530c818b1445d3b73afa0b",
"sha256": "8518af07b50d57b981f5f0023e878e44d707954df167e881b323249964d641eb"
},
"downloads": -1,
"filename": "pyvista4dolfinx-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "5550b7464c530c818b1445d3b73afa0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9564,
"upload_time": "2025-07-09T08:36:37",
"upload_time_iso_8601": "2025-07-09T08:36:37.026146Z",
"url": "https://files.pythonhosted.org/packages/4a/e4/981d3626abea0da471189d191ca0b53a4af05176a85415bb94654d1d4086/pyvista4dolfinx-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 08:36:37",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "fenicsx4flow",
"gitlab_project": "pyvista4dolfinx",
"lcname": "pyvista4dolfinx"
}
