You're reading the documentation for a development version. For the latest released version, please have a look at v0.1.

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.

Note

This is a transitional package meant to be used only until the evedata package is considered sufficiently stable for routine use. It provides a rather low-level interface to the eveH5 data files, lacking many of the abstractions available within evedata. See Differences to evedata for more details.

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. For more details, see the documentation of the evefile module and the Use cases section.

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

Warning

evefile is currently under active development and still considered in Beta development state. Therefore, expect frequent changes in features and public APIs that may break your own code. Nevertheless, feedback as well as feature requests are highly welcome.

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.