Lightweight library for plotting FEniCS x objects using plotly
Project description
fenicsx-plotly
fenicsx-plotly
is package for plotting FEniCSx objects using plotly. It is a successor of fenics-plotly
.
- Documentation: https://finsberg.github.io/fenicsx-plotly/
- Source code: https://github.com/finsberg/fenicsx-plotly
Install
To install fenicsx-plotly
you need to first install FEniCSx. Next you can install fenicsx-plotly
via pip
python3 -m pip install fenicsx-plotly
We also provide a pre-built docker image with FEniCSx and fenicsx-plotly
installed. You pull this image using the command
docker pull ghcr.io/finsberg/fenicsx-plotly:v0.3.0
Simple Example
import dolfinx
from mpi4py import MPI
from fenicsx_plotly import plot
mesh = dolfinx.mesh.create_unit_cube(MPI.COMM_WORLD, 3, 3, 3)
plot(mesh)
Supported objects (and object that will be supported in the future)
- dolfinx.mesh.Mesh
- dolfinx.mesh.MeshTagsMetaClass
- dolfinx.fem.FunctionSpace
- dolfinx.fem.Function
- Scalar
- Vector
- dolfinx.fem.bcs.DirichletBCMetaClass
- Scalar
- Vector
Usage with JupyterBook
If you want to embed the visualizations generated by fenicsx-plotly
into a webpage generated by JupyterBook such as the documentation for fenicsx-plotly
you need to add the following configuration in your _config.yml
sphinx:
config:
html_js_files:
- https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
See https://jupyterbook.org/en/stable/interactive/interactive.html#plotly for more information.
Contributing
Contributions are welcomed!
See https://finsberg.github.io/fenicsx-plotly/CONTRIBUTING.html for more info.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fenicsx_plotly-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 391de5efbb4a3c04e976b0555fa99579bc9581728fd8de829ade65beb803f3b6 |
|
MD5 | bff35542c17948cf618186703472125d |
|
BLAKE2b-256 | 349dfc7825a6827ac7eb49fd11e0b550d6d68b1051b87c00485439881c0c32de |