radiometry

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

https://github.com/tillbiskup/radiometry

Keywords

Repository

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

README.rst

==========
radiometry
==========

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

Welcome! This is 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


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


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

There is a number of related packages users of the radiometry package may well be interested in, as they have a similar scope, focussing on scientific data analysis and reproducible research.

* `ASpecD `_

  A Python framework for the analysis of spectroscopic data focussing on reproducibility and good scientific practice. The framework the radiometry package is based on, developed by T. Biskup.

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

Finally, don't forget to check out the website on `reproducible research `_ covering in more general terms aspects of reproducible research and good scientific practice.


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.

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: radiometry
abstract: >
    Reproducible and automated processing and analysis of (synchrotron) radiometry data based on the ASpecD framework
authors:
  - family-names: Biskup
    given-names: Till
    orcid: "https://orcid.org/0000-0003-2913-0004"
type: software
license: GPL-3.0
repository-code: "https://github.com/tillbiskup/radiometry"
keywords:
  - "eve"
  - "radiometry"
  - "synchrotron"
  - "metrology"
  - "PTB"
  - "BESSY"
# Highly recommended starting with the first release: DOI via Zenodo
#identifiers:
#  - description: "The concept DOI of the work."
#    type: doi
#    value: 10.5281/zenodo.########

GitHub Events