https://github.com/festim-dev/openmc2dolfinx

A repository to handle the conversion of OpenMC data to dolfinx functions

https://github.com/festim-dev/openmc2dolfinx

Science Score: 23.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

A repository to handle the conversion of OpenMC data to dolfinx functions

Basic Info
  • Host: GitHub
  • Owner: festim-dev
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 43 KB
Statistics
  • Stars: 4
  • Watchers: 0
  • Forks: 0
  • Open Issues: 3
  • Releases: 0
Created about 1 year ago · Last pushed 7 months ago
Metadata Files
Readme License

README.md

openmc2dolfinx

Conda CI Docker CI Code style: Ruff

openmc2dolfinx is a lightweight tool for converting OpenMC output data (in .vtk format) into dolfinx-compatible fem.Function objects. It is primarily designed to facilitate multiphysics coupling between OpenMC and finite element simulations (e.g. thermal, diffusion, or tritium transport analyses).

Key features

  • Convert structured and unstructured VTK meshes to dolfinx meshes.
  • Interpolate OpenMC tally results directly into dolfinx Function spaces.
  • Integrated with PyVista for mesh and data inspection.

Installation

Using conda:

bash conda create -n openmc2dolfinx-env conda activate openmc2dolfinx-env conda install -c conda-forge fenics-dolfinx=0.9.0 mpich pyvista Once in the created in environment: bash python -m pip install openmc2dolfinx

Example usage

```python from openmc2dolfinx import StructuredGridReader, UnstructuredMeshReader import pyvista as pv import numpy as np import dolfinx from mpi4py import MPI

download an example tetmesh

filename = pv.examples.download_tetrahedron(load=False)

grid = pv.read(filename)

assign random cell data

grid.celldata["mean"] = np.arange(grid.ncells) grid.save("out.vtk")

read the vtk file

reader = UnstructuredMeshReader("out.vtk")

make a dolfinx function

u = reader.createdolfinxfunction("mean")

export to vtk for visualisation

writer = dolfinx.io.VTXWriter(MPI.COMM_WORLD, "out.bp", u, "BP5") writer.write(t=0) ```

Owner

  • Name: festim-dev
  • Login: festim-dev
  • Kind: organization

GitHub Events

Total
  • Issues event: 2
  • Watch event: 3
  • Delete event: 1
  • Issue comment event: 3
  • Push event: 14
  • Pull request review event: 6
  • Pull request review comment event: 8
  • Pull request event: 4
  • Create event: 3
Last Year
  • Issues event: 2
  • Watch event: 3
  • Delete event: 1
  • Issue comment event: 3
  • Push event: 14
  • Pull request review event: 6
  • Pull request review comment event: 8
  • Pull request event: 4
  • Create event: 3

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 36
  • Total Committers: 4
  • Avg Commits per committer: 9.0
  • Development Distribution Score (DDS): 0.306
Past Year
  • Commits: 36
  • Committers: 4
  • Avg Commits per committer: 9.0
  • Development Distribution Score (DDS): 0.306
Top Committers
Name Email Commits
jhdark d****5@m****u 25
jhdark j****5@g****m 7
James Dark 6****k@u****m 3
Rémi Delaporte-Mathurin 4****n@u****m 1
Committer Domains (Top 20 + Academic)
mit.edu: 1

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 93 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
pypi.org: openmc2dolfinx

Convert OpenMC .vtk files to dolfinx functions

  • Homepage: https://github.com/festim-dev/openmc2dolfinx
  • Documentation: https://openmc2dolfinx.readthedocs.io/
  • License: MIT License Copyright (c) 2025 festim-dev 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: 1.0
    published 7 months ago
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 93 Last month
Rankings
Dependent packages count: 8.5%
Downloads: 23.0%
Stargazers count: 24.9%
Average: 27.0%
Forks count: 30.9%
Dependent repos count: 47.8%
Maintainers (1)
Last synced: 6 months ago

Dependencies

pyproject.toml pypi
  • fenics-dolfinx >=0.9.0
  • pyvista *