radiometry

Reproducible and automated processing and analysis of (synchrotron) radiometry data based on the ASpecD framework.

Welcome! This is the documentation for 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).

Due to inheriting from the ASpecD framework, all data generated with the radiometry package are completely reproducible and have a complete history.

Features

A list of (planned) features:

  • Generalised data model for (synchrotron) radiometry data

  • A growing list of general-purpose processing and analysis steps

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

  • Open source project written in Python (>= 3.7)

  • Developed fully test-driven

  • Extensive user and API documentation

Warning

radiometry 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 radiometry package on your computer (sensibly within a Python virtual environment), open a terminal (activate your virtual environment), and type in the following:

pip install radiometry

License

This program is free software: you can redistribute it and/or modify it under the terms of the GPLv3 License.