Skip to content

Commit ffe0484

Browse files
committed
additional details
1 parent 6fd2e8f commit ffe0484

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,19 @@
44
[![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)
55
[![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)
66

7-
`openmc2dolfinx` is a tool for converting OpenMC output `.vtk` files to functions that can be used within [dolfinx](https://github.com/FEniCS/dolfinx).
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.
815

916
## Installation
1017

18+
Using **conda**:
19+
1120
```bash
1221
conda create -n openmc2dolfinx-env
1322
conda activate openmc2dolfinx-env
@@ -18,7 +27,8 @@ Once in the created in environment:
1827
python -m pip install openmc2dolfinx
1928
```
2029

21-
## Exmaple usage
30+
## Example usage
31+
2232
```python
2333
from openmc2dolfinx import StructuredGridReader, UnstructuredMeshReader
2434
import pyvista as pv

0 commit comments

Comments
 (0)