Skip to main content

PORous RANdom crystal structure generation

Project description

PORRAN

PORous structure RANdom generation. Can be used for substituting atoms in porous crystals like zeolites, or doping Metal-Organic Frameworks. Algorithms used for substitutions are based on the ZEORAN program [1].

Installation

Install with pip

The simplest way to install PORRAN is through pip, which automatically gets the source code from PyPI:

pip install porran

Install from source

It is also possible to install PORRAN directly from the source. This can be done using the commands bellow:

git clone https://github.com/marko-petkovic/porran.git
cd porran
pip install .

Getting started

More examples will follow in the future

Examples

  • An example on using PORRAN to generate zeolite structures (MOR) with Al substitutions can be found here.
  • Using PORRAN to generate MOFs functionalized with lithium-alkoxide: mofs_example.

References

[1] Romero-Marimon, P., Gutiérrez-Sevillano, J. J., & Calero, S. (2023). Adsorption of Carbon Dioxide in Non-Löwenstein Zeolites. Chemistry of Materials, 35(13), 5222-5231.

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

porran-0.0.6.tar.gz (15.1 kB view hashes)

Uploaded Source

Built Distribution

porran-0.0.6-py3-none-any.whl (16.5 kB view hashes)

Uploaded Python 3

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