Metadata-Version: 2.4
Name: porescene
Version: 0.3.0
Summary: Blender-based Python toolkit for reproducible, publication-quality 3D visualization of porous media – tomographic images, pore networks, and tessellations.
License-Expression: GPL-3.0-only
License-File: LICENSE
Author: Felix Faber
Author-email: felix.faber@ovgu.de
Requires-Python: >=3.13,<3.14
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: bpy
Requires-Dist: h5py
Requires-Dist: imageio-ffmpeg (>=0.6.0,<0.7.0)
Requires-Dist: numpy
Requires-Dist: pillow
Requires-Dist: resvg-py (>=0.3.3,<0.4.0)
Requires-Dist: rich
Project-URL: Documentation, https://porescene.readthedocs.io
Project-URL: Repository, https://github.com/fefafe/porescene
Description-Content-Type: text/markdown

# PoreScene

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.21494378.svg)](https://doi.org/10.5281/zenodo.21494378)
[![PyPI](https://img.shields.io/pypi/v/porescene)](https://pypi.org/project/porescene/)
[![Python](https://img.shields.io/pypi/pyversions/porescene)](https://pypi.org/project/porescene/)
[![License](https://img.shields.io/pypi/l/porescene)](https://github.com/fefafe/porescene/blob/main/LICENSE)
[![Docs](https://readthedocs.org/projects/porescene/badge/?version=latest)](https://porescene.readthedocs.io/en/latest/?badge=latest)
[![Release](https://img.shields.io/github/actions/workflow/status/fefafe/porescene/release.yml?label=release)](https://github.com/fefafe/porescene/actions/workflows/release.yml)

PoreScene is a [Blender](https://docs.blender.org/api/current/)-based scientific
visualization toolkit for porous media. It renders tomographic images, generated and
reconstructed pore networks, as well as volume tessellations as photorealistic 3D scenes
– with pores, throats, Voronoi cells, and watershed clusters colored by properties such
as radius or coordination number using perceptually uniform colormaps, matching
colorbars, and calibrated, on-scale axes.

The advantage: instead of clicking through a 3D editor, you describe the entire scene in a
few lines of Python and render it reproducibly on Blender's GPU-accelerated *Cycles*
engine – so the same script always yields the same publication-quality figure, ready for
papers, presentations, and animations.

## Installation

```console
pip install porescene
```

More detailed instructions are provided in the [documentation](https://porescene.readthedocs.io).

## Citation

If you use PoreScene to generate figures for a publication, please cite it. Citation
metadata is provided in [`CITATION.cff`](CITATION.cff), and the software is archived on
Zenodo under a version-independent concept
[DOI](https://doi.org/10.5281/zenodo.21494378) that always resolves to the latest release.
You can use the BibTeX entry below:

```bibtex
@software{porescene,
  author = {Faber, Felix and Vorhauer-Huget, Nicole},
  title  = {{PoreScene}},
  year   = {2026},
  doi    = {10.5281/zenodo.21494378},
  url    = {https://github.com/fefafe/porescene},
}
```

## Funding

This work was funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) – Project-ID 422037413 – TRR 287.

