Skip to content

Commit 5fa07a2

Browse files
authored
Merge pull request #15 from festim-dev/update_readme
Update README
2 parents bfb1d17 + ffe0484 commit 5fa07a2

1 file changed

Lines changed: 28 additions & 2 deletions

File tree

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
11
# openmc2dolfinx
2-
A repository to handle the conversion of results in OpenMC vtk files to dolfinx functions
32

3+
[![Conda CI](https://github.com/festim-dev/openmc2dolfinx/actions/workflows/ci_conda.yml/badge.svg)](https://github.com/festim-dev/openmc2dolfinx/actions/workflows/ci_conda.yml)
4+
[![Docker CI](https://github.com/festim-dev/openmc2dolfinx/actions/workflows/ci_docker.yml/badge.svg)](https://github.com/festim-dev/openmc2dolfinx/actions/workflows/ci_docker.yml)
5+
[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
6+
7+
`openmc2dolfinx` is a lightweight tool for converting [OpenMC](https://github.com/openmc-dev/openmc) output data (in `.vtk` format) into [dolfinx](https://github.com/FEniCS/dolfinx)-compatible `fem.Function` objects.
8+
It is primarily designed to facilitate multiphysics coupling between OpenMC and finite element simulations (e.g. thermal, diffusion, or tritium transport analyses).
9+
10+
## Key features
11+
12+
- Convert structured and unstructured VTK meshes to dolfinx meshes.
13+
- Interpolate OpenMC tally results directly into dolfinx Function spaces.
14+
- Integrated with PyVista for mesh and data inspection.
15+
16+
## Installation
17+
18+
Using **conda**:
19+
20+
```bash
21+
conda create -n openmc2dolfinx-env
22+
conda activate openmc2dolfinx-env
23+
conda install -c conda-forge fenics-dolfinx=0.9.0 mpich pyvista
24+
```
25+
Once in the created in environment:
26+
```bash
27+
python -m pip install openmc2dolfinx
28+
```
29+
30+
## Example usage
431

5-
## Usage
632
```python
733
from openmc2dolfinx import StructuredGridReader, UnstructuredMeshReader
834
import pyvista as pv

0 commit comments

Comments
 (0)