https://github.com/tillbiskup/evefile

Transitional package to read eveH5 files containing synchrotron radiometry data recorded at BESSY/MLS in Berlin.
https://github.com/tillbiskup/evefile

bessy eve mls ptb radiometry synchrotron

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/tillbiskup/evefile
• Owner: tillbiskup
• License: other
• Created: 2025-08-01T08:17:12.000Z (2 months ago)
• Default Branch: master
• Last Pushed: 2025-08-22T12:13:21.000Z (about 2 months ago)
• Last Synced: 2025-08-22T14:29:34.640Z (about 2 months ago)
• Topics: bessy, eve, mls, ptb, radiometry, synchrotron
• Language: Python
• Homepage: https://evefile.docs.radiometry.de/
• Size: 435 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: COPYING
  • Citation: CITATION.cff
  • Roadmap: docs/roadmap.rst

Awesome Lists containing this project

README

          

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.16815768.svg

   :target: https://doi.org/10.5281/zenodo.16815768

   :align: right

=======

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) `_. 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.

Loading the contents of a data file of a measurement is as simple as::

    import evefile

    file = evefile.EveFile(filename="my_measurement_file.h5")

Here, ``file`` contains all the information contained in the data file as a hierarchy of Python objects.

Features

========

A list of features:

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

* Fully backwards-compatible to older eveH5 versions

* Complete information available that is contained in an eveH5 file

* Data are (only) loaded on demand, not when loading the file

* Powerful and intuitive abstractions, allowing for associative access to data and information – beyond a purely tabular view of the data

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 `_

  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) `_. 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 `_

  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) `_.

* `evedataviewer `_

  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) `_.

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.