adsorption-file-parser


Nameadsorption-file-parser JSON
Version 0.3.0 PyPI version JSON
download
home_pageNone
SummaryCollection of parsers for (nearly) all commercial adsorption instrumentation
upload_time2025-01-10 22:50:37
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License Copyright (c) 2022, AIF Dev Team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords adsorption characterization porous materials isotherms sorption
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Adsorption File Parser
======================

A pure python parser to sorption files from various instrumentation manufacturers.
It comes with minimal dependencies and maximum flexibility.

Currently supports files from:

- Micromeritics ('.xls' reports)
- Surface Measurement Systems DVS ('.xlsx' reports)
- 3P instruments ('.xlsx' reports)
- Quantachrome ('.txt' raw isotherm data)
- MicrotracBEL ('.dat', '.xls' and '.csv' files)

.. start-badges

.. list-table::
    :widths: 10 90
    :stub-columns: 1

    * - status
      - | |status| |commits-since|
    * - license
      - | |license|
    * - tests
      - | |GHA| |codecov|
    * - 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/AIF-development-team/adsorption-file-parser/latest/develop
    :alt: Commits since latest release
    :target: https://github.com/AIF-development-team/adsorption-file-parser/compare/master...develop

.. |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/AIF-development-team/adsorption-file-parser/actions/workflows/CI-CD.yaml/badge.svg
    :alt: GHA-CI Build Status
    :target: https://github.com/AIF-development-team/adsorption-file-parser/actions

.. |codecov| image:: https://img.shields.io/codecov/c/github/AIF-development-team/adsorption-file-parser.svg
    :alt: Coverage Status
    :target: https://codecov.io/gh/AIF-development-team/adsorption-file-parser

.. |version| image:: https://img.shields.io/pypi/v/adsorption-file-parser.svg
    :alt: PyPI Package latest release
    :target: https://pypi.org/project/adsorption-file-parser/

.. |wheel| image:: https://img.shields.io/pypi/wheel/adsorption-file-parser.svg
    :alt: PyPI Wheel
    :target: https://pypi.org/project/adsorption-file-parser/

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/adsorption-file-parser.svg
    :alt: Supported versions
    :target: https://pypi.org/project/adsorption-file-parser/

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/adsorption-file-parser.svg
    :alt: Supported implementations
    :target: https://pypi.org/project/adsorption-file-parser/

.. end-badges


Installation
============

Install using pip

.. code:: bash

    pip install adsorption-file-parser


Documentation
=============

The main read function returns two dictionaries: a ``meta`` dictionary, which
contains various metadata that is present in the report (date, user, units) and
the ``data`` dictionary, containing lists of individual isotherm data.

.. code:: bash

    from adsorption_file_parser import read
    meta, data = read(
        path="path/to/file",
        manufacturer="manufacturer",
        fmt="supported format"
    )

Bugs or questions?
==================

For any bugs found or feature requests, please open an
`issue <https://github.com/AIF-development-team/adsorption-file-parser/issues/>`__
or, even better, submit a
`pull request <https://github.com/AIF-development-team/adsorption-file-parser/pulls/>`__.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adsorption-file-parser",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "adsorption, characterization, porous materials, isotherms, sorption",
    "author": null,
    "author_email": "AIF Development Team <mail@pauliacomi.com>",
    "download_url": "https://files.pythonhosted.org/packages/f2/49/42ad5a4a2cba8952dcd001e64607db8f6e6c9b00870387e166fd3d1d86b3/adsorption_file_parser-0.3.0.tar.gz",
    "platform": null,
    "description": "Adsorption File Parser\n======================\n\nA pure python parser to sorption files from various instrumentation manufacturers.\nIt comes with minimal dependencies and maximum flexibility.\n\nCurrently supports files from:\n\n- Micromeritics ('.xls' reports)\n- Surface Measurement Systems DVS ('.xlsx' reports)\n- 3P instruments ('.xlsx' reports)\n- Quantachrome ('.txt' raw isotherm data)\n- MicrotracBEL ('.dat', '.xls' and '.csv' files)\n\n.. start-badges\n\n.. list-table::\n    :widths: 10 90\n    :stub-columns: 1\n\n    * - status\n      - | |status| |commits-since|\n    * - license\n      - | |license|\n    * - tests\n      - | |GHA| |codecov|\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/AIF-development-team/adsorption-file-parser/latest/develop\n    :alt: Commits since latest release\n    :target: https://github.com/AIF-development-team/adsorption-file-parser/compare/master...develop\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/AIF-development-team/adsorption-file-parser/actions/workflows/CI-CD.yaml/badge.svg\n    :alt: GHA-CI Build Status\n    :target: https://github.com/AIF-development-team/adsorption-file-parser/actions\n\n.. |codecov| image:: https://img.shields.io/codecov/c/github/AIF-development-team/adsorption-file-parser.svg\n    :alt: Coverage Status\n    :target: https://codecov.io/gh/AIF-development-team/adsorption-file-parser\n\n.. |version| image:: https://img.shields.io/pypi/v/adsorption-file-parser.svg\n    :alt: PyPI Package latest release\n    :target: https://pypi.org/project/adsorption-file-parser/\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/adsorption-file-parser.svg\n    :alt: PyPI Wheel\n    :target: https://pypi.org/project/adsorption-file-parser/\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/adsorption-file-parser.svg\n    :alt: Supported versions\n    :target: https://pypi.org/project/adsorption-file-parser/\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/adsorption-file-parser.svg\n    :alt: Supported implementations\n    :target: https://pypi.org/project/adsorption-file-parser/\n\n.. end-badges\n\n\nInstallation\n============\n\nInstall using pip\n\n.. code:: bash\n\n    pip install adsorption-file-parser\n\n\nDocumentation\n=============\n\nThe main read function returns two dictionaries: a ``meta`` dictionary, which\ncontains various metadata that is present in the report (date, user, units) and\nthe ``data`` dictionary, containing lists of individual isotherm data.\n\n.. code:: bash\n\n    from adsorption_file_parser import read\n    meta, data = read(\n        path=\"path/to/file\",\n        manufacturer=\"manufacturer\",\n        fmt=\"supported format\"\n    )\n\nBugs or questions?\n==================\n\nFor any bugs found or feature requests, please open an\n`issue <https://github.com/AIF-development-team/adsorption-file-parser/issues/>`__\nor, even better, submit a\n`pull request <https://github.com/AIF-development-team/adsorption-file-parser/pulls/>`__.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2022, AIF Dev Team  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Collection of parsers for (nearly) all commercial adsorption instrumentation",
    "version": "0.3.0",
    "project_urls": {
        "Documentation": "https://adsorption-file-parser.readthedocs.io",
        "Homepage": "https://github.com/AIF-development-team/adsorption-file-parser",
        "Repository": "https://github.com/AIF-development-team/adsorption-file-parser.git"
    },
    "split_keywords": [
        "adsorption",
        " characterization",
        " porous materials",
        " isotherms",
        " sorption"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b7245ea1d13445c3dac93cab37d0b1e035e0b7f8518be51c4af7460df73a1ba6",
                "md5": "91225f05bfe519153a3e337910deca4d",
                "sha256": "10952db57ba7ca58935c5892085b5de1408715e72b0c2b102a599261ec8c9603"
            },
            "downloads": -1,
            "filename": "adsorption_file_parser-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "91225f05bfe519153a3e337910deca4d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 31766,
            "upload_time": "2025-01-10T22:50:34",
            "upload_time_iso_8601": "2025-01-10T22:50:34.751877Z",
            "url": "https://files.pythonhosted.org/packages/b7/24/5ea1d13445c3dac93cab37d0b1e035e0b7f8518be51c4af7460df73a1ba6/adsorption_file_parser-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f24942ad5a4a2cba8952dcd001e64607db8f6e6c9b00870387e166fd3d1d86b3",
                "md5": "242d581765022edef91f16c20ee98bcd",
                "sha256": "cd55a97f7b8f166d50ea0cba26359674289fd289838c4fb256d2215784dd708f"
            },
            "downloads": -1,
            "filename": "adsorption_file_parser-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "242d581765022edef91f16c20ee98bcd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 2171517,
            "upload_time": "2025-01-10T22:50:37",
            "upload_time_iso_8601": "2025-01-10T22:50:37.790810Z",
            "url": "https://files.pythonhosted.org/packages/f2/49/42ad5a4a2cba8952dcd001e64607db8f6e6c9b00870387e166fd3d1d86b3/adsorption_file_parser-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-10 22:50:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "AIF-development-team",
    "github_project": "adsorption-file-parser",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "adsorption-file-parser"
}
        
Elapsed time: 1.48413s