diff --git a/README.md b/README.md index e1e3297..c72082f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,34 @@ # openmc2dolfinx -A repository to handle the conversion of results in OpenMC vtk files to dolfinx functions +[![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) +[![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) +[![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) + +`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. +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 -## Usage ```python from openmc2dolfinx import StructuredGridReader, UnstructuredMeshReader import pyvista as pv