Data

Tools

Indexes

Applications

Experiments

Open Source Science

fenicsx-plotly

https://github.com/finsberg/fenicsx-plotly

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 3 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Contributing License Citation

README.md

MIT PyPI version Test package Pre-commit Deploy static content to Pages Code style: black Create and publish a Docker image Coverage

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

```python import dolfinx from mpi4py import MPI from fenicsx_plotly import plot

mesh = dolfinx.mesh.createunitcube(MPI.COMM_WORLD, 3, 3, 3)

plot(mesh) ```

Supported objects (and object that will be supported in the future)

  • [x] dolfinx.mesh.Mesh
  • [x] dolfinx.mesh.MeshTagsMetaClass
  • [x] dolfinx.fem.FunctionSpace
  • [x] dolfinx.fem.Function
    • [x] Scalar
    • [x] Vector
  • [ ] dolfinx.fem.bcs.DirichletBCMetaClass
    • [x] 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 yaml 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.

Owner

  • Name: Henrik Finsberg
  • Login: finsberg
  • Kind: user
  • Location: Oslo, Norway
  • Company: Simula Research Laboratoy

Senior Research Engineer working with Scientific Computing and Computational Physiology

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Finsberg"
  given-names: "Henrik"
  orcid: "ABCD-ABCD-ACBD-ABCD"
title: "fenicsx-plotly"
version: "0.1.0"
date-released: 2022-12-25

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 10
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 minutes
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • finsberg (10)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 62 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 0
  • Total versions: 7
  • Total maintainers: 1
pypi.org: fenicsx-plotly

Lightweight library for plotting FEniCS x objects using plotly

  • Documentation: https://fenicsx-plotly.readthedocs.io/
  • License: Copyright 2022 Henrik Finsberg Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.3.0
    published almost 3 years ago
  • Versions: 7
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 62 Last month
Rankings
Dependent packages count: 6.6%
Average: 18.6%
Dependent repos count: 30.6%
Maintainers (1)
finsberg
Last synced: 10 months ago

Dependencies

.github/workflows/build_docs.yml actions
  • actions/checkout v3 composite
  • actions/configure-pages v2 composite
  • actions/deploy-pages v1 composite
  • actions/upload-pages-artifact v1 composite
.github/workflows/docker-image.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action v3 composite
  • docker/login-action v2 composite
  • docker/metadata-action v4 composite
  • docker/setup-buildx-action v2 composite
  • docker/setup-qemu-action v2 composite
.github/workflows/pre-commit.yml actions
  • actions/checkout v3 composite
.github/workflows/pypi.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish master composite
.github/workflows/test_package_coverage.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • schneegans/dynamic-badges-action v1.6.0 composite
Dockerfile docker
  • ghcr.io/finsberg/fenicsx-plotly v0.2.0 build
docker/Dockerfile docker
  • ghcr.io/fenics/dolfinx/dolfinx nightly build
pyproject.toml pypi
  • fenics-dolfinx *
  • ipywidgets ==7.7.2
  • numpy *
  • plotly *