Skip to main content

Porosity Evaluation tool

Project description

# porE ![GitHub Logo](/images/porE_logo_v1.png) ## PORosity Evaluation tool

[![license](https://img.shields.io/badge/license-APACHE2-green)](https://www.apache.org/licenses/LICENSE-2.0) [![language](https://img.shields.io/badge/language-Python3-blue)](https://www.python.org/) [![language](https://img.shields.io/badge/language-FORTRAN-red)](https://www.fortran.com/) [![version](https://img.shields.io/badge/version-1.0.2-lightgrey)](https://github.com/kaitrepte/porE/blob/master/README.md) [![researchgate](https://img.shields.io/static/v1?label=researchgate&message=MOFs&style=social&logo=researchgate)](https://www.researchgate.net/project/Systematic-and-efficient-theoretical-investigations-of-metal-organic-frameworks-MOFs) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3973264.svg)](https://doi.org/10.5281/zenodo.3973264)

Main developer:

## Installation (global pip installation) `bash $ pip3 install porE ` ## Installation (local pip installation) `bash $ git clone https://github.com/kaitrepte/porE $ 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

## Reference results Several results from porE are summarized in the porE/results folder.

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.3.tar.gz (31.6 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: porE-1.0.3.tar.gz
  • Upload date:
  • Size: 31.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for porE-1.0.3.tar.gz
Algorithm Hash digest
SHA256 01374cee4a7dab9d7a59f8122f2c42a0d1518b128e92f0139c35b0ff282dc79a
MD5 ed22ee965a16934858194065246040b9
BLAKE2b-256 10b85cab9541a44729cb0b87d65c4b3472fc5793891142cb46d13a820de56034

See more details on using hashes here.

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