Documentation
Online documentation is available at PoreMS.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/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 .
Testing
To test PoreSim, run the test in the test directory.
Development
PoreSim development takes place on Github: www.github.com/PoreMS/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.)
1 maintainer
Metadata
1 maintainer
Release files for poresim 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| poresim-0.3.0.tar.gz | 36.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| poresim-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 77.1 kB
Release files / poresim-0.3.0.tar.gz
| Download URL | poresim-0.3.0.tar.gz |
|---|---|
| Size | 36.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
51d21e8515d36cbcf6dc9e7c5a3d6a43803f36e47fb8c418bb517887e9cedc0f
|
|
BLAKE2b-256 checksum How to use checksums |
a8173dd5fc04d6dc274e679431ffd1f5ef424113b5222737d11d07474b2397c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.24
|
Release files / poresim-0.3.0-py3-none-any.whl
| Download URL | poresim-0.3.0-py3-none-any.whl |
|---|---|
| Size | 40.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f6e448a011cd7c8d8543871af1f63144b4a696ce7bf12c3d5f1701c0e9121f62
|
|
BLAKE2b-256 checksum How to use checksums |
8274760ee703593bf96db662e1fa3ca4caacda772a8f893155a6a4568c62c259
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.24
|
Security for poresim 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
