From 6fd2e8fc50de0af47a878b55867035072fd81b3d Mon Sep 17 00:00:00 2001 From: jhdark Date: Wed, 8 Oct 2025 14:18:17 -0400 Subject: [PATCH 1/2] update readme --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e1e3297..232474e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,24 @@ # 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) -## Usage +`openmc2dolfinx` is a tool for converting OpenMC output `.vtk` files to functions that can be used within [dolfinx](https://github.com/FEniCS/dolfinx). + +## Installation + +```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 +``` + +## Exmaple usage ```python from openmc2dolfinx import StructuredGridReader, UnstructuredMeshReader import pyvista as pv From ffe04841a24fca9809491d5161d32903f96dd5cc Mon Sep 17 00:00:00 2001 From: jhdark Date: Wed, 8 Oct 2025 14:25:55 -0400 Subject: [PATCH 2/2] additional details --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 232474e..c72082f 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,19 @@ [![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 tool for converting OpenMC output `.vtk` files to functions that can be used within [dolfinx](https://github.com/FEniCS/dolfinx). +`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 @@ -18,7 +27,8 @@ Once in the created in environment: python -m pip install openmc2dolfinx ``` -## Exmaple usage +## Example usage + ```python from openmc2dolfinx import StructuredGridReader, UnstructuredMeshReader import pyvista as pv