Skip to main content

Porosity Evaluation tool

Project description

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).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

porE-1.0.7.tar.gz (40.4 kB view details)

Uploaded Source

File details

Details for the file porE-1.0.7.tar.gz.

File metadata

  • Download URL: porE-1.0.7.tar.gz
  • Upload date:
  • Size: 40.4 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for porE-1.0.7.tar.gz
Algorithm Hash digest
SHA256 10f4806d4da43da0c445b3561aebab9660278778e165734ea00d34cc2a78ccf6
MD5 d99461b576b64d3042b401d00f5386f6
BLAKE2b-256 48c814a50b4487257566ee266307bda0087fd83aa6b11926c98446f55e6d7c98

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page