Metadata-Version: 2.4
Name: micress-micpy
Version: 0.4.3b3
Summary: MicPy is a Python package to facilitate MICRESS workflows.
Author: Lukas Koschmieder
Author-email: l.koschmieder@access-technology.de
License: BSD-3-Clause (Copyright (c) 2024-2026 Access e.V.)
Keywords: MICRESS
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: rapidgzip
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<center>

![MicPy logo](https://docs.micress.de/micpy/images/micpy-logo.png)

</center>

# 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**.
- Export field data to **VTK** as either **CellData** or **PointData**.
- Includes a **ParaView plugin** for directly opening MICRESS binary field files, with on-the-fly switching between CellData and PointData.

## Installation

Install MicPy from PyPI:

```bash
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

```python
from micpy.tab import read

df = read("A001_Delta_Gamma.TabF")

print(df.head())
```

### Read and visualize field data

```python
from micpy.bin import read

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

fig, ax, cbar = field.plot()
```

### Export to VTK

```python
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.
