Metadata-Version: 2.4
Name: icmesh
Version: 0.1.0
Summary: Mesh, geometry and OpenFOAM utilities for technical computing.
Author: Irish Centre for High End Computing
License: MIT
Project-URL: Repository, https://git.ichec.ie/platform-engineering/modules/ichec-mesh
Project-URL: Homepage, https://git.ichec.ie/platform-engineering/modules/ichec-mesh
Keywords: Meshing,Geometry,OpenFOAM,CFD
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: iccore==0.2.3
Requires-Dist: icplot
Provides-Extra: vtk
Requires-Dist: vtk; extra == "vtk"
Dynamic: license-file

# icmesh

Mesh, geometry and OpenFOAM utilities, used at
[ICHEC](https://www.ichec.ie) for technical computing and CFD pre-processing.

Extracted from [icplot](https://git.ichec.ie/platform-engineering/modules/documentation/ichec-plot)
at its 0.5.0 tag, where the VTK and OpenFOAM backends were holding a plotting
library's toolchain hostage.

# Features #

`geometry`: points, vectors, shapes (cuboid, cylinder, annulus, quad, circle),
transforms and geometric operations.

`mesh`: hexahedral cells, edges, vertices and meshing operations, with
OpenFOAM `blockMesh`/`polyMesh` read and write, and VTK export.

# Installation #

``` shell
pip install icmesh
```

`numpy` and `scipy` are core. VTK export is opt-in, since it is a heavy
dependency:

``` shell
pip install icmesh[vtk]
```

Writing an OpenFOAM mesh through `blockMesh` needs OpenFOAM itself on the
system; the code paths guard on its presence.

# Copyright #

Copyright 2026 Irish Centre for High End Computing

The software in this repository can be used under the conditions of the MIT
license, which is available for reading in the accompanying LICENSE file.
