Skip to main content

porE

GitHub Logo

PORosity Evaluation tool

license language language version
researchgate DOI

Main developer:

Installation (global pip installation)

$ pip3 install porE

Installation (local pip installation)

$ git clone https://gitlab.com/kaitrepte/porE.git
$ cd porE
$ pip3 install -e .

Running the code

There are several calculations types one can choose from:

  • HEA : He approach.
    Calculates the He void fraction using a cell list approach.

  • OSA : Overlapping sphere approach.
    Calculates the porosity via two-body overlaps of spheres.

  • GPA : Grid point approach.
    Void and accessible porosity are calculated using a grid in the unit cell.

  • PSD : Pore size distribution.
    Using a Monte-Carlo scheme, the pore size distribution is calculated.

To run the code, go to the examples folder.
The file run_porE.py contains examples for the
execution on the non-GUI level.
The file run_GUI.py will execute the graphical
user interface, including the OSA, GPA and PSD functionalities.
The HEA will be implemented soon.

Special thanks goes to Sebastian Schwalbe for writing the GUI and for many other useful discussions.

Additional information

The basic outline of the porE code and its applications are summarized in

Please also see the published version in the Journal of Computational Chemistry (JCC)

We create some YouTube videos to introduce and explain the porE code

Reference results

Several results from porE are summarized in the porE/results folder (Status: Early 2021).

Release files for porE 1.0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for porE 1.0.7
File Size Uploaded
porE-1.0.7.tar.gz 40.4 kB Details

Release files / porE-1.0.7.tar.gz

Download URL porE-1.0.7.tar.gz
Size 40.4 kB
Tags Source
SHA-256 checksum
How to use checksums
10f4806d4da43da0c445b3561aebab9660278778e165734ea00d34cc2a78ccf6
BLAKE2b-256 checksum
How to use checksums
48c814a50b4487257566ee266307bda0087fd83aa6b11926c98446f55e6d7c98
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.10

Release history Release notifications | RSS feed

This release

1.0.7 This release

1 release file

1.0.6

1 release file

1.0.5

1 release file

1.0.4

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page