MicPy

MicPy is a Python package for working with MICRESS simulation data. It provides efficient tools to read, process, visualize, and convert MICRESS output, helping streamline simulation workflows.

Features

• Read MICRESS tabular output directly into Pandas DataFrames.
• Read MICRESS binary field data into NumPy arrays.
• Quickly visualize field data with a built-in Matplotlib plotting interface with automatic physical axis scaling.
• Export field data to VTK as either CellData or PointData, with support for length unit conversion and legacy VTK files.
• Use the ParaView plugin to directly open MICRESS binary field files, switch between CellData and PointData, and convert length units on the fly.
• Extend MICRESS datasets beyond their original simulation domain directly in ParaView, with support for periodic, insulating, and symmetric boundary conditions.

Installation

Install MicPy from PyPI:

pip install micress-micpy

Requires Python 3.11 or later.

Documentation

Full documentation, tutorials, and API reference are available at:

https://docs.micress.de/micpy/

Quick Start

Read tabular output

from micpy.tab import read

df = read("A001_Delta_Gamma.TabF")

print(df.head())

Read and visualize field data

from micpy.bin import read

field = read("A001_Delta_Gamma.conc1", -1)  # last timestep

fig, ax, cbar = field.plot()

Export to VTK

from micpy.bin import read

field = read("A001_Delta_Gamma.conc1", -1)

field.save_vti("conc1.vti")

Contributing

Bug reports, feature requests, and contributions are welcome. Please open an issue or submit a pull request through the project repository.