Online documentation is available at PoreMS.github.io/PoreSim.
The docs include an example for creating simulation boxes, and an API reference.
PoreSim supports Python 3.5+.
Installation requires pyyaml and jinja2.
You may instead want to use the development version from GitHub:
pip install git+https://github.com/PoreMS/PoreSim.git#egg=poresim
pip install git+https://github.com/PoreMS/PoreSim.git@develop#egg=poresim
Or download the repository and install in the top directory via:
pip install .
To test PoreSim, run the test in the test directory.
PoreSim development takes place on Github: www.github.com/PoreMS/PoreSim
Please submit any reproducible bugs you encounter to the issue tracker.
When citing PoreSim please use the current Zenodo DOI corresponding to the used PoreSim version. (Current DOI is listed in the badges.)
This repository contains the actively maintained and current codebase.
Earlier development stages and archived versions (including those used in publication XYZ) are stored in the following legacy repository:
https://github.com/Ajax23/PoreSim
Please note:
- Legacy versions are no longer actively maintained
- APIs, file formats, and dependencies may differ