Pore system simulation generator.
Project description
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.)
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file poresim-0.2.0.tar.gz.
File metadata
- Download URL: poresim-0.2.0.tar.gz
- Upload date:
- Size: 35.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 965d055e3ef30b50e38abda810282552a84d47ef916a8eabc1ba3aca35a53457 |
|
| MD5 | 3c7468607ad9d421c5029c52b05d67f0 |
|
| BLAKE2b-256 | 5b835a7fefb958dff864c546c3703dbcb59c2308ed164e34c8923d0f9f24ae94 |
File details
Details for the file poresim-0.2.0-py3-none-any.whl.
File metadata
- Download URL: poresim-0.2.0-py3-none-any.whl
- Upload date:
- Size: 40.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7de84086811d2b3eac77f3234c6ca421bd8e595980637beb41d6c2b66b56cad8 |
|
| MD5 | 821e1f72a4c6388022215e1c5f67018a |
|
| BLAKE2b-256 | cbc4afacf994bccf5c3ff99e74dc3bcc7a57172e929e88e7ae8c8f5023d2ce69 |
