evefile


Nameevefile JSON
Version 0.1.0rc1 PyPI version JSON
download
home_pagehttps://www.ptb.de/cms/en/ptb/fachabteilungen/abt7/ptb-sr.html
SummaryTransitional package to read eveH5 files containing synchrotron radiometry data recorded at BESSY/MLS in Berlin
upload_time2025-08-12 19:17:31
maintainerNone
docs_urlNone
authorTill Biskup
requires_python>=3.7
licenseGPLv3
keywords eve radiometry synchrotron ptb bessy mls
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =======
evefile
=======

*Transitional package to read eveH5 files containing synchrotron radiometry data recorded at BESSY/MLS in Berlin.*

Welcome! This is evefile, a Python package for **importing (synchrotron) radiometry data** obtained at one of the beamlines at **BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_. This package acts as transitional interface between the (eveH5) data files and the processing and analysis code. For related packages for importing, viewing, and analysing those data, have a look at the "related projects" section below.


Features
========

A list of (planned) features:

* Importer for eve HDF5 files (used at PTB in Berlin, Germany)

* Fully backwards-compatible to older eveH5 versions


And to make it even more convenient for users and future-proof:

* Open source project written in Python (>= 3.9)

* Developed fully test-driven

* Extensive user and API documentation


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

To install the evefile package on your computer (sensibly within a Python virtual environment), open a terminal (activate your virtual environment), and type in the following::

    pip install evefile


Related projects
================

There is a number of related packages users of the evedata package may well be interested in, as they have a similar scope, focussing on working with synchrotron radiometry data.

* `evedata <https://evedata.docs.radiometry.de>`_

  A Python package for **importing (synchrotron) radiometry data** obtained at one of the beamlines at **BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_. In contrast to ``evefile``, this package will provide powerful and intuitive abstractions, allowing for associative access to data and information. Hence, ``evefile`` is only a transitional package for use until ``evedata`` is considered sufficiently stable for routine use.

* `radiometry <https://docs.radiometry.de>`_

  A Python package for **processing and analysing (synchrotron) radiometry data** in a **reproducible** and mostly **automated** fashion. Currently, it focusses on data obtained at one of the beamlines at **BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_.

* `evedataviewer <https://evedataviewer.docs.radiometry.de>`_

  A Python package for **graphically inspecting data** contained in EVE files, *i.e.* data **obtained at one of the beamlines at BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_.


License
=======

This program is free software: you can redistribute it and/or modify it under the terms of the **GPLv3 License**. See the file ``LICENSE`` for more details.

            

Raw data

            {
    "_id": null,
    "home_page": "https://www.ptb.de/cms/en/ptb/fachabteilungen/abt7/ptb-sr.html",
    "name": "evefile",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "eve, radiometry, synchrotron, PTB, BESSY, MLS",
    "author": "Till Biskup",
    "author_email": "till.biskup@ptb.de",
    "download_url": "https://files.pythonhosted.org/packages/6f/54/e20a53fb63a74be56e68e4ffe5ddc819b5299f4a79351a9d5baff5f6c651/evefile-0.1.0rc1.tar.gz",
    "platform": null,
    "description": "=======\nevefile\n=======\n\n*Transitional package to read eveH5 files containing synchrotron radiometry data recorded at BESSY/MLS in Berlin.*\n\nWelcome! This is evefile, a Python package for **importing (synchrotron) radiometry data** obtained at one of the beamlines at **BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_. This package acts as transitional interface between the (eveH5) data files and the processing and analysis code. For related packages for importing, viewing, and analysing those data, have a look at the \"related projects\" section below.\n\n\nFeatures\n========\n\nA list of (planned) features:\n\n* Importer for eve HDF5 files (used at PTB in Berlin, Germany)\n\n* Fully backwards-compatible to older eveH5 versions\n\n\nAnd to make it even more convenient for users and future-proof:\n\n* Open source project written in Python (>= 3.9)\n\n* Developed fully test-driven\n\n* Extensive user and API documentation\n\n\nInstallation\n============\n\nTo install the evefile package on your computer (sensibly within a Python virtual environment), open a terminal (activate your virtual environment), and type in the following::\n\n    pip install evefile\n\n\nRelated projects\n================\n\nThere is a number of related packages users of the evedata package may well be interested in, as they have a similar scope, focussing on working with synchrotron radiometry data.\n\n* `evedata <https://evedata.docs.radiometry.de>`_\n\n  A Python package for **importing (synchrotron) radiometry data** obtained at one of the beamlines at **BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_. In contrast to ``evefile``, this package will provide powerful and intuitive abstractions, allowing for associative access to data and information. Hence, ``evefile`` is only a transitional package for use until ``evedata`` is considered sufficiently stable for routine use.\n\n* `radiometry <https://docs.radiometry.de>`_\n\n  A Python package for **processing and analysing (synchrotron) radiometry data** in a **reproducible** and mostly **automated** fashion. Currently, it focusses on data obtained at one of the beamlines at **BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_.\n\n* `evedataviewer <https://evedataviewer.docs.radiometry.de>`_\n\n  A Python package for **graphically inspecting data** contained in EVE files, *i.e.* data **obtained at one of the beamlines at BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_.\n\n\nLicense\n=======\n\nThis program is free software: you can redistribute it and/or modify it under the terms of the **GPLv3 License**. See the file ``LICENSE`` for more details.\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "Transitional package to read eveH5 files containing synchrotron radiometry data recorded at BESSY/MLS in Berlin",
    "version": "0.1.0rc1",
    "project_urls": {
        "Documentation": "https://evefile.docs.radiometry.de/",
        "Homepage": "https://www.ptb.de/cms/en/ptb/fachabteilungen/abt7/ptb-sr.html",
        "Source": "https://github.com/tillbiskup/evefile"
    },
    "split_keywords": [
        "eve",
        " radiometry",
        " synchrotron",
        " ptb",
        " bessy",
        " mls"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "bf5e4c83779b35ea240d424a653c35ef809650dfd138904e3a81ac3e46d8061f",
                "md5": "ec193ae1003248798f64ffb7e1c6839a",
                "sha256": "9a8521b3a55a17146bea11c08937e300b4a32fb18b0e905c9edced376413fb53"
            },
            "downloads": -1,
            "filename": "evefile-0.1.0rc1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ec193ae1003248798f64ffb7e1c6839a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 141360,
            "upload_time": "2025-08-12T19:17:27",
            "upload_time_iso_8601": "2025-08-12T19:17:27.414939Z",
            "url": "https://files.pythonhosted.org/packages/bf/5e/4c83779b35ea240d424a653c35ef809650dfd138904e3a81ac3e46d8061f/evefile-0.1.0rc1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6f54e20a53fb63a74be56e68e4ffe5ddc819b5299f4a79351a9d5baff5f6c651",
                "md5": "efc209610fff6d9e1683fbabae4456ba",
                "sha256": "528152f6ada9aae30a94324b021913ea060ea6f1768695ab59967f64a510dfa7"
            },
            "downloads": -1,
            "filename": "evefile-0.1.0rc1.tar.gz",
            "has_sig": false,
            "md5_digest": "efc209610fff6d9e1683fbabae4456ba",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 145354,
            "upload_time": "2025-08-12T19:17:31",
            "upload_time_iso_8601": "2025-08-12T19:17:31.673979Z",
            "url": "https://files.pythonhosted.org/packages/6f/54/e20a53fb63a74be56e68e4ffe5ddc819b5299f4a79351a9d5baff5f6c651/evefile-0.1.0rc1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-12 19:17:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tillbiskup",
    "github_project": "evefile",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "evefile"
}
        
Elapsed time: 0.40284s