Skip to main content

Pore Generator for Molecular Simulations.

Project description

PoreMS: A Pore Generator for Molecular Simulations

PyPI Version License: GPL v3 DOI Build Status codecov Language grade: Python

Documentation

Online documentation is available at ajax23.github.io/PoreMS.

The docs include an example for generating molecules and pores, and an API reference. Visit process for an overview of the programs operating principle.

An examplary workflow has been provided for using the PoreMS package to create a pore system and run molecular dynamics simulation using Gromacs.

Dependencies

PoreMS supports Python 3.5+.

Installation requires numpy, pandas and matplotlib.

Installation

The latest stable release (and older versions) can be installed from PyPI:

pip install porems

You may instead want to use the development version from Github:

pip install git+https://github.com/ajax23/porems.git#egg=porems

pip install git+https://github.com/ajax23/porems.git@develop#egg=porems

Or download the repository and install in the top directory via:

pip install .

Testing

To test porems, run the test in the test directory.

Development

PoreMS development takes place on Github: www.github.com/Ajax23/PoreMS

Please submit any reproducible bugs you encounter to the issue tracker.

How to Cite PoreMS

When citing PoreMS please use the following: Kraus et al., Molecular Simulation, 2021, DOI: 10.1080/08927022.2020.1871478

Additionaly, to assure reproducability of the generated pore systems, please cite the Zenodo DOI corresponding to the used PoreMS version. (Current DOI is listed in the badges.)

Published Work

  • Kraus et al., 2021. PoreMS: a software tool for generating silica pore models with user-defined surface functionalisation and pore dimensions. Molecular Simulation, pp.1-11, doi:10.1080/08927022.2020.1871478.
  • Kobayashi et al., 2021. Confined Ru‐catalysts in a Two‐phase Heptane/Ionic Liquid Solution: Modeling Aspects. ChemCatChem, 13(2), pp.739-746, doi:10.1002/cctc.202001596.
  • Ziegler et al., 2019. Olefin Metathesis in Confined Geometries: A Biomimetic Approach toward Selective Macrocyclization. Journal of the American Chemical Society, 141(48), pp.19014-19022, doi:10.1021/jacs.9b08776.

Project details


Download files

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

Files for porems, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size porems-0.2.2.tar.gz (41.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page