Pore system simulation generator.
Project description
PoreSim: Pore System Simulation Generator
Documentation
Online documentation is available at ajax23.github.io/PoreSim.
The docs include an example for creating simulation boxes, and an API reference.
Dependencies
PoreSim supports Python 3.5+.
Installation requires pyyaml and jinja2.
Installation
You may instead want to use the development version from GitHub:
pip install git+https://github.com/ajax23/PoreSim.git#egg=poresim
pip install git+https://github.com/ajax23/PoreSim.git@develop#egg=poresim
Or download the repository and install in the top directory via:
pip install .
Testing
To test PoreSim, run the test in the test directory.
Development
PoreSim development takes place on Github: www.github.com/Ajax23/PoreSim
Please submit any reproducible bugs you encounter to the issue tracker.
How to Cite PoreSim
When citing PoreSim please use the current Zenodo DOI corresponding to the used PoreSim version. (Current DOI is listed in the badges.)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
