Online documentation is available at ajax23.github.io/PoreAna.
The docs include an example for analyzing density and diffusion, and an API reference.
PoreAna supports Python 3.5+.
Installation requires numpy, pandas, chemfiles 0.10.0, seaborn and porems.
You may instead want to use the development version from GitHub:
pip install git+https://github.com/ajax23/PoreAna.git#egg=poreana
pip install git+https://github.com/ajax23/PoreAna.git@develop#egg=poreana
Or download the repository and install in the top directory via:
pip install .
To test PoreAna, run the test in the test directory.
PoreAna development takes place on Github: www.github.com/Ajax23/PoreAna
Please submit any reproducible bugs you encounter to the issue tracker.
When citing PoreAna please use the current Zenodo DOI corresponding to the used PoreAna version. (Current DOI is listed in the badges.)