Skip to main content

Framework for processing gas adsorption isotherms

Project description



https://raw.githubusercontent.com/pauliacomi/pyGAPS/master/docs/logo.svg

Overview

pyGAPS (Python General Adsorption Processing Suite) is a framework for adsorption data analysis and fitting, written in Python 3.

status

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Commits since latest release

docs

Documentation Status

license

Project License

tests

GHA-CI Build Status Coverage Status
Requirements Status

package

PyPI Package latest release PyPI Wheel
Supported versions Supported implementations

Features

  • Advanced adsorption data import and manipulation.

  • A fully feature thermodynamic backend allowing conversions between pressures, temperatures, loadings, etc.

  • Routine analysis such as BET/Langmuir surface area, t-plots, alpha-s plots, Dubinin plots etc.

  • Pore size distribution calculations for mesopores (BJH, Dollimore-Heal).

  • Pore size distribution calculations for micropores (Horvath-Kawazoe).

  • Pore size distribution calculations using kernels (DFT, QSDFT, …)

  • Isotherm fitting with various models (Henry, Langmuir, DS/TS Langmuir, etc..)

  • Enthalpy of adsorption calculations.

  • IAST predictions for binary and multicomponent adsorption.

  • Parsing to and from multiple formats such as AIF, Excel, CSV and JSON.

  • Simple methods for isotherm graphing and comparison.

  • An database backend for storing and retrieving data.

Documentation

pyGAPS is built with three key mantras in mind:

  • Opinionated: there are many places where the code will suggest or default to what the it considers a good practice. As examples: the standard units, pore size distribution methods and BET calculation limits.

  • Flexible: while the defaults are there for a reason, you can override pretty much any parameter. Want to pass a custom adsorbate thickness function or use volumetric bases? Can do!

  • Transparent: all code is well documented and open source. There are no black boxes.

In-depth explanations, examples and theory can be found in the online documentation. If you are familiar with Python and adsorption and want to jump right in, look at the quickstart section. Examples for each of the capabilities specified above can be found documented here. Most of the pages are actually Jupyter Notebooks, you can download them and run them yourself from the /docs/examples folder.

To become well familiarised with the concepts introduced by pyGAPS, such as what is an Isotherm, how units work, what data is required and can be stored etc., a deep dive is available in the manual.

Finally, having a strong grasp of the science of adsorption is recommended, to understand the strengths and shortcomings of various methods. We have done our best to explain the theory and application range of each capability and model. To learn more, look at the reference or simply call help() from a python interpreter (for example help(pygaps.PointIsotherm).

Support and sponsorship

This project is graciously sponsored by Surface Measurement Systems, by employing Paul Iacomi, the core maintainer. The work would not be possible without their contribution, keeping this open source project alive.

https://raw.githubusercontent.com/pauliacomi/pyGAPS/master/docs/figures/SMS-Logo.jpg

If you are interested in implementing a particular feature, or obtaining professional level support, contact us here Bugs or questions?.

Citing

Please consider citing the related paper we published if you use the program in your research.

Paul Iacomi, Philip L. Llewellyn, Adsorption (2019). pyGAPS: A Python-Based Framework for Adsorption Isotherm Processing and Material Characterisation. DOI: https://doi.org/10.1007/s10450-019-00168-5

Installation

The easiest way to install pyGAPS is from the command line. You can use pip:

pip install pygaps

or Anaconda/Conda:

conda install -c conda-forge pygaps

If you are just starting out, Anaconda/Conda is a good bet since it manages virtual environments for you. Check out Installation for more details.

Development

To install the development branch, clone the repository from GitHub. Then install the package with pip either in regular or developer mode.

git clone https://github.com/pauliacomi/pyGAPS

# then install editable/develop mode
# adding [dev] will install the development dependencies
pip install -e ./pyGAPS[dev]

If you want to contribute to pyGAPS or develop your own code from the package, check out the detailed information in CONTRIBUTING.rst.

Bugs or questions?

For any bugs found, please open an issue or, even better, submit a pull request. It’ll make my life easier. This also applies to any features which you think might benefit the project. I’m also more than happy to answer any questions. Shoot an email to mail( at )pauliacomi.com or find me at https://pauliacomi.com or on Twitter.

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

pygaps-4.6.1.tar.gz (4.4 MB view details)

Uploaded Source

Built Distribution

pygaps-4.6.1-py3-none-any.whl (343.8 kB view details)

Uploaded Python 3

File details

Details for the file pygaps-4.6.1.tar.gz.

File metadata

  • Download URL: pygaps-4.6.1.tar.gz
  • Upload date:
  • Size: 4.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pygaps-4.6.1.tar.gz
Algorithm Hash digest
SHA256 30079276252fd5f5f03b89e2ec3af29bc01c2befc7302d1263cc72bdbb2eca2f
MD5 f244d478bd73dfc3425e7f842f200272
BLAKE2b-256 e375a26da3455c473f3f25364ef6c66dc887cff943d0438aaf3298f057b1c9b6

See more details on using hashes here.

File details

Details for the file pygaps-4.6.1-py3-none-any.whl.

File metadata

  • Download URL: pygaps-4.6.1-py3-none-any.whl
  • Upload date:
  • Size: 343.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pygaps-4.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 322dd78af79c62668f43d3141278a22676d99339787f273af24abb1f22e22533
MD5 d68c0b466fb55340598944a24546ebf4
BLAKE2b-256 7953e0ecd56998cb92242cdbea6a5fa45e0a6bce7e68454a020bccfb6a8fbec0

See more details on using hashes here.

Supported by

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