adsorption-file-parser


Nameadsorption-file-parser JSON
Version 0.2.8 PyPI version JSON
download
home_pagehttps://github.com/AIF-development-team/adsorption-file-parser
SummaryCollection of parsers for (nearly) all commercial adsorption instrumentation.
upload_time2023-12-04 10:24:34
maintainer
docs_urlNone
authorAIF Dev Team
requires_python>=3.7
licenseMIT license
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": "https://github.com/AIF-development-team/adsorption-file-parser",
    "name": "adsorption-file-parser",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "adsorption,characterization,porous materials,isotherms,sorption",
    "author": "AIF Dev Team",
    "author_email": "mail@pauliacomi.com",
    "download_url": "https://files.pythonhosted.org/packages/2d/c2/6882953c9da1f2fcdaebb96fcc3f28b5ba1846a224f95f7cb57d17aeb37b/adsorption_file_parser-0.2.8.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:\na ``meta`` dictionary, which contains various metadata\nthat is present in the report (date, user, units)\nand the ``data`` dictionary, containing lists\nof 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",
    "summary": "Collection of parsers for (nearly) all commercial adsorption instrumentation.",
    "version": "0.2.8",
    "project_urls": {
        "Homepage": "https://github.com/AIF-development-team/adsorption-file-parser",
        "Source Code": "https://github.com/AIF-development-team/adsorption-file-parser"
    },
    "split_keywords": [
        "adsorption",
        "characterization",
        "porous materials",
        "isotherms",
        "sorption"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cbccd0eee9c97858ec999aa9d2aadb10b08fa8a0045518a067ff23149d17d89f",
                "md5": "9f6a416b21270fe1465a5cf4bcb3e91a",
                "sha256": "ac66466e65c680ea6580809a4dabb7ceaf86d877e4b78150d5e7851980839058"
            },
            "downloads": -1,
            "filename": "adsorption_file_parser-0.2.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9f6a416b21270fe1465a5cf4bcb3e91a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 29610,
            "upload_time": "2023-12-04T10:24:32",
            "upload_time_iso_8601": "2023-12-04T10:24:32.937920Z",
            "url": "https://files.pythonhosted.org/packages/cb/cc/d0eee9c97858ec999aa9d2aadb10b08fa8a0045518a067ff23149d17d89f/adsorption_file_parser-0.2.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2dc26882953c9da1f2fcdaebb96fcc3f28b5ba1846a224f95f7cb57d17aeb37b",
                "md5": "5425e86b1f2414e82a1287ee085b4635",
                "sha256": "e2bd3d0e626d2056753ecf405af68c66751a42f4199cd3fb92cc15224d3e40ac"
            },
            "downloads": -1,
            "filename": "adsorption_file_parser-0.2.8.tar.gz",
            "has_sig": false,
            "md5_digest": "5425e86b1f2414e82a1287ee085b4635",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 2157022,
            "upload_time": "2023-12-04T10:24:34",
            "upload_time_iso_8601": "2023-12-04T10:24:34.878450Z",
            "url": "https://files.pythonhosted.org/packages/2d/c2/6882953c9da1f2fcdaebb96fcc3f28b5ba1846a224f95f7cb57d17aeb37b/adsorption_file_parser-0.2.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-04 10:24:34",
    "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: 0.39932s