|
|
.. image:: https://raw.githubusercontent.com/pauliacomi/pyGAPS/master/docs/logo.svg
:width: 200px
:align: center
========
Overview
========
pyGAPS (Python General Adsorption Processing Suite) is a framework for
adsorption data analysis and fitting, written in Python 3.
.. start-badges
.. list-table::
:widths: 10 90
:stub-columns: 1
* - status
- | |status| |commits-since|
* - docs
- | |docs|
* - license
- | |license|
* - tests
- | |GHA| |codecov|
| |requires|
* - package
- | |version| |wheel|
| |supported-versions| |supported-implementations|
.. |status| image:: https://www.repostatus.org/badges/latest/active.svg
:target: https://www.repostatus.org/#active
:alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.
.. |commits-since| image:: https://img.shields.io/github/commits-since/pauliacomi/pygaps/latest/develop
:alt: Commits since latest release
:target: https://github.com/pauliacomi/pygaps/compare/master...develop
.. |docs| image:: https://readthedocs.org/projects/pygaps/badge/?style=flat
:target: https://readthedocs.org/projects/pygaps
:alt: Documentation Status
.. |license| image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT
:alt: Project License
.. |GHA| image:: https://github.com/pauliacomi/pyGAPS/workflows/CI/badge.svg
:alt: GHA-CI Build Status
:target: https://github.com/pauliacomi/pyGAPS/actions
.. |requires| image:: https://requires.io/github/pauliacomi/pyGAPS/requirements.svg?branch=master
:alt: Requirements Status
:target: https://requires.io/github/pauliacomi/pyGAPS/requirements/?branch=master
.. |codecov| image:: https://img.shields.io/codecov/c/github/pauliacomi/pygaps.svg
:alt: Coverage Status
:target: https://codecov.io/gh/pauliacomi/pyGAPS
.. |version| image:: https://img.shields.io/pypi/v/pygaps.svg
:alt: PyPI Package latest release
:target: https://pypi.org/project/pygaps
.. |wheel| image:: https://img.shields.io/pypi/wheel/pygaps.svg
:alt: PyPI Wheel
:target: https://pypi.org/project/pygaps
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/pygaps.svg
:alt: Supported versions
:target: https://pypi.org/project/pygaps
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/pygaps.svg
:alt: Supported implementations
:target: https://pypi.org/project/pygaps
.. end-badges
Features
========
- Advanced adsorption data import and manipulation.
- 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..)
- Isosteric 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 <https://pygaps.readthedocs.io/>`__. If you are familiar
with Python and adsorption and want to jump right in, look at the `quickstart
section <https://pygaps.readthedocs.io/en/master/examples/quickstart.html>`__.
Examples for each of the capabilities specified above can be found documented
`here <https://pygaps.readthedocs.io/en/master/examples/index.html>`__. Most of
the pages are actually Jupyter Notebooks, you can download them and run them
yourself from the
`/docs/examples <https://github.com/pauliacomi/pyGAPS/tree/master/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 <https://pygaps.readthedocs.io/en/master/manual/index.html>`__.
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 <https://pygaps.readthedocs.io/en/master/reference/index.html>`__ 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 <https://surfacemeasurementsystems.com/>`__, by
employing Paul Iacomi, the core maintainer. The work would not be possible
without their contribution, keeping this open source project alive.
.. image:: https://raw.githubusercontent.com/pauliacomi/pyGAPS/master/docs/figures/SMS-Logo.jpg
:width: 200px
:align: left
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. Using ``pip`` for
example:
.. code:: bash
pip install pygaps
or `Anaconda/Conda <https://www.anaconda.com/>`__:
.. code:: bash
conda install -c conda-forge pygaps
If you are just starting out, `Anaconda/Conda <https://www.anaconda.com/>`__ is
a good bet since it manages virtual environments for you. Check out
`Installation <https://pygaps.readthedocs.io/en/master/installation.html>`__ 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.
.. code:: bash
git clone https://github.com/pauliacomi/pyGAPS
# then install
pip install ./pyGAPS
# or in editable/develop mode
pip install -e ./pyGAPS
If you want to contribute to pyGAPS or develop your own code from the package,
check out the detailed information in
`CONTRIBUTING.rst <https://pygaps.readthedocs.io/en/master/contributing.html>`__.
Bugs or questions?
==================
For any bugs found, please open an
`issue <https://github.com/pauliacomi/pyGAPS/issues/>`__ or, even better, submit
a `pull request <https://github.com/pauliacomi/pyGAPS/pulls/>`__. 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 <https://twitter.com/iacomip>`__.
Raw data
{
"_id": null,
"home_page": "https://github.com/pauliacomi/pygaps",
"name": "pygaps",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "adsorption,characterization,porous materials,isotherms",
"author": "Paul Iacomi",
"author_email": "mail@pauliacomi.com",
"download_url": "https://files.pythonhosted.org/packages/2f/14/75a10c3032e1d506d5f34b52ae1b4c72e1c1541d85dcae3da2a3c9918625/pygaps-4.5.0.tar.gz",
"platform": null,
"description": "\n|\n|\n\n.. image:: https://raw.githubusercontent.com/pauliacomi/pyGAPS/master/docs/logo.svg\n :width: 200px\n :align: center\n\n========\nOverview\n========\n\npyGAPS (Python General Adsorption Processing Suite) is a framework for\nadsorption data analysis and fitting, written in Python 3.\n\n.. start-badges\n\n.. list-table::\n :widths: 10 90\n :stub-columns: 1\n\n * - status\n - | |status| |commits-since|\n * - docs\n - | |docs|\n * - license\n - | |license|\n * - tests\n - | |GHA| |codecov|\n | |requires|\n * - package\n - | |version| |wheel|\n | |supported-versions| |supported-implementations|\n\n.. |status| image:: https://www.repostatus.org/badges/latest/active.svg\n :target: https://www.repostatus.org/#active\n :alt: Project Status: Active \u2013 The project has reached a stable, usable state and is being actively developed.\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/pauliacomi/pygaps/latest/develop\n :alt: Commits since latest release\n :target: https://github.com/pauliacomi/pygaps/compare/master...develop\n\n.. |docs| image:: https://readthedocs.org/projects/pygaps/badge/?style=flat\n :target: https://readthedocs.org/projects/pygaps\n :alt: Documentation Status\n\n.. |license| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: Project License\n\n.. |GHA| image:: https://github.com/pauliacomi/pyGAPS/workflows/CI/badge.svg\n :alt: GHA-CI Build Status\n :target: https://github.com/pauliacomi/pyGAPS/actions\n\n.. |requires| image:: https://requires.io/github/pauliacomi/pyGAPS/requirements.svg?branch=master\n :alt: Requirements Status\n :target: https://requires.io/github/pauliacomi/pyGAPS/requirements/?branch=master\n\n.. |codecov| image:: https://img.shields.io/codecov/c/github/pauliacomi/pygaps.svg\n :alt: Coverage Status\n :target: https://codecov.io/gh/pauliacomi/pyGAPS\n\n.. |version| image:: https://img.shields.io/pypi/v/pygaps.svg\n :alt: PyPI Package latest release\n :target: https://pypi.org/project/pygaps\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/pygaps.svg\n :alt: PyPI Wheel\n :target: https://pypi.org/project/pygaps\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/pygaps.svg\n :alt: Supported versions\n :target: https://pypi.org/project/pygaps\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/pygaps.svg\n :alt: Supported implementations\n :target: https://pypi.org/project/pygaps\n\n\n.. end-badges\n\n\nFeatures\n========\n\n - Advanced adsorption data import and manipulation.\n - Routine analysis such as BET/Langmuir surface area, t-plots, alpha-s\n plots, Dubinin plots etc.\n - Pore size distribution calculations for mesopores (BJH, Dollimore-Heal).\n - Pore size distribution calculations for micropores (Horvath-Kawazoe).\n - Pore size distribution calculations using kernels (DFT, QSDFT, ...)\n - Isotherm fitting with various models (Henry, Langmuir, DS/TS Langmuir,\n etc..)\n - Isosteric enthalpy of adsorption calculations.\n - IAST predictions for binary and multicomponent adsorption.\n - Parsing to and from multiple formats such as AIF, Excel, CSV and JSON.\n - Simple methods for isotherm graphing and comparison.\n - An database backend for storing and retrieving data.\n\nDocumentation\n=============\n\npyGAPS is built with three key mantras in mind:\n\n- **Opinionated**: there are many places where the code will suggest or default\n to what the it considers a good practice. As examples: the standard units,\n pore size distribution methods and BET calculation limits.\n- **Flexible**: while the defaults are there for a reason, you can override\n pretty much any parameter. Want to pass a custom adsorbate thickness function\n or use volumetric bases? Can do!\n- **Transparent**: all code is well documented and open source. There are no\n black boxes.\n\nIn-depth explanations, examples and theory can be found in the\n`online documentation <https://pygaps.readthedocs.io/>`__. If you are familiar\nwith Python and adsorption and want to jump right in, look at the `quickstart\nsection <https://pygaps.readthedocs.io/en/master/examples/quickstart.html>`__.\nExamples for each of the capabilities specified above can be found documented\n`here <https://pygaps.readthedocs.io/en/master/examples/index.html>`__. Most of\nthe pages are actually Jupyter Notebooks, you can download them and run them\nyourself from the\n`/docs/examples <https://github.com/pauliacomi/pyGAPS/tree/master/docs/examples>`__\nfolder.\n\nTo become well familiarised with the concepts introduced by pyGAPS, such as what\nis an Isotherm, how units work, what data is required and can be stored etc., a\ndeep dive is available in the\n`manual <https://pygaps.readthedocs.io/en/master/manual/index.html>`__.\n\nFinally, having a strong grasp of the science of adsorption is recommended, to\nunderstand the strengths and shortcomings of various methods. We have done our\nbest to explain the theory and application range of each capability and model.\nTo learn more, look at the\n`reference <https://pygaps.readthedocs.io/en/master/reference/index.html>`__ or\nsimply call ``help()`` from a python interpreter (for example\n``help(pygaps.PointIsotherm)``.\n\nSupport and sponsorship\n=======================\n\nThis project is graciously sponsored by\n`Surface Measurement Systems <https://surfacemeasurementsystems.com/>`__, by\nemploying Paul Iacomi, the core maintainer. The work would not be possible\nwithout their contribution, keeping this open source project alive.\n\n.. image:: https://raw.githubusercontent.com/pauliacomi/pyGAPS/master/docs/figures/SMS-Logo.jpg\n :width: 200px\n :align: left\n\nIf you are interested in implementing a particular feature,\nor obtaining professional level support, contact us here\n`Bugs or questions?`_.\n\nCiting\n======\n\nPlease consider citing the related paper we published if you use\nthe program in your research.\n\n Paul Iacomi, Philip L. Llewellyn, *Adsorption* (2019).\n pyGAPS: A Python-Based Framework for Adsorption Isotherm\n Processing and Material Characterisation.\n DOI: https://doi.org/10.1007/s10450-019-00168-5\n\nInstallation\n============\n\nThe easiest way to install pyGAPS is from the command line. Using ``pip`` for\nexample:\n\n.. code:: bash\n\n pip install pygaps\n\nor `Anaconda/Conda <https://www.anaconda.com/>`__:\n\n.. code:: bash\n\n conda install -c conda-forge pygaps\n\nIf you are just starting out, `Anaconda/Conda <https://www.anaconda.com/>`__ is\na good bet since it manages virtual environments for you. Check out\n`Installation <https://pygaps.readthedocs.io/en/master/installation.html>`__ for\nmore details.\n\nDevelopment\n===========\n\nTo install the development branch, clone the repository from GitHub.\nThen install the package with pip either in regular or developer mode.\n\n.. code:: bash\n\n git clone https://github.com/pauliacomi/pyGAPS\n\n # then install\n pip install ./pyGAPS\n\n # or in editable/develop mode\n pip install -e ./pyGAPS\n\nIf you want to contribute to pyGAPS or develop your own code from the package,\ncheck out the detailed information in\n`CONTRIBUTING.rst <https://pygaps.readthedocs.io/en/master/contributing.html>`__.\n\nBugs or questions?\n==================\n\nFor any bugs found, please open an\n`issue <https://github.com/pauliacomi/pyGAPS/issues/>`__ or, even better, submit\na `pull request <https://github.com/pauliacomi/pyGAPS/pulls/>`__. It'll make my\nlife easier. This also applies to any features which you think might benefit the\nproject. I'm also more than happy to answer any questions. Shoot an email to\nmail( at )pauliacomi.com or find me at https://pauliacomi.com or on\n`Twitter <https://twitter.com/iacomip>`__.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A framework for processing adsorption data for porous materials.",
"version": "4.5.0",
"project_urls": {
"Documentation": "https://pygaps.readthedocs.io",
"Homepage": "https://github.com/pauliacomi/pygaps",
"Source Code": "https://github.com/pauliacomi/pygaps"
},
"split_keywords": [
"adsorption",
"characterization",
"porous materials",
"isotherms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a94912c403002023af2dd537084fcf5955ee2635c6cd63d969b56063c459f058",
"md5": "fc5b8538362e1a32f8ee911d2c1597b2",
"sha256": "ec7847d7a0bafaa4875d2c5307eae4522228ed4d795e8af9fbc296e8fe264339"
},
"downloads": -1,
"filename": "pygaps-4.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc5b8538362e1a32f8ee911d2c1597b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 326667,
"upload_time": "2023-06-20T00:28:22",
"upload_time_iso_8601": "2023-06-20T00:28:22.937027Z",
"url": "https://files.pythonhosted.org/packages/a9/49/12c403002023af2dd537084fcf5955ee2635c6cd63d969b56063c459f058/pygaps-4.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2f1475a10c3032e1d506d5f34b52ae1b4c72e1c1541d85dcae3da2a3c9918625",
"md5": "7e348c3d86517b5f6ef8b0e2721c8214",
"sha256": "c31e3a52e8cd23a3f10152d19a2675945964fc9bce29256a156894700a8e1eaf"
},
"downloads": -1,
"filename": "pygaps-4.5.0.tar.gz",
"has_sig": false,
"md5_digest": "7e348c3d86517b5f6ef8b0e2721c8214",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5525758,
"upload_time": "2023-06-20T00:28:25",
"upload_time_iso_8601": "2023-06-20T00:28:25.601163Z",
"url": "https://files.pythonhosted.org/packages/2f/14/75a10c3032e1d506d5f34b52ae1b4c72e1c1541d85dcae3da2a3c9918625/pygaps-4.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-20 00:28:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pauliacomi",
"github_project": "pygaps",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pygaps"
}
JSON
