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

https://zenodo.org/badge/DOI/10.5281/zenodo.4896687.svg

cwepr documentation

Welcome! This is the documentation for cwepr, a Python package for processing and analysis of continuous-wave electron paramagnetic resonance (cw-EPR) spectra based on the ASpecD framework. For general information see its Homepage. Due to the inheritance from the ASpecD framework, all data generated with the cwepr package are completely reproducible and have a complete history.

What is even better: Actual data processing and analysis no longer requires programming skills, but is as simple as writing a text file summarising all the steps you want to have been performed on your dataset(s) in an organised way. Curious? Have a look at the following example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
format:
  type: ASpecD recipe
  version: '0.2'

settings:
  default_package: cwepr

datasets:
  - /path/to/first/dataset
  - /path/to/second/dataset

tasks:
  - kind: processing
    type: FrequencyCorrection
    properties:
      parameters:
        frequency: 9.8
  - kind: processing
    type: BaselineCorrection
    properties:
      parameters:
        order: 0
  - kind: singleplot
    type: SinglePlotter1D
    properties:
      filename:
        - first-dataset.pdf
        - second-dataset.pdf

Interested in more real-live examples? Check out the use cases section and the growing list of examples providing complete recipes for different needs.

Features

A list of features:

  • Fully reproducible processing and analysis of cw-EPR data.

  • Gap-less record of each processing/analysis step, including explicit and implicit parameters.

  • Import of EPR data from diverse sources (Bruker ESP, EMX, Elexsys; Magnettech; NIEHS PEST)

  • Generic representation of EPR data, independent of the original format.

  • Datasets contain both, numerical data and all crucial metadata, a prerequisite for FAIR data.

  • Generic plotting capabilities, easily extendable

  • Report generation using pre-defined templates

  • Recipe-driven data analysis, allowing tasks to be performed fully unattended in the background

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

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

  • Extensive user and API documentation

Warning

The cwepr package 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.

How to cite

cwepr is free software. However, if you use cwepr for your own research, please cite both, the article describing it and the software itself:

  • Mirjam Schröder, Till Biskup. cwepr – a Python package for analysing cw-EPR data focussing on reproducibility and simple usage. Journal of Magnetic Resonance 335:107140, 2022. doi:10.1016/j.jmr.2021.107140

  • Mirjam Schröder, Till Biskup. cwepr (2021). doi:10.5281/zenodo.4896687

To make things easier, cwepr has a DOI provided by Zenodo, and you may click on the badge below to directly access the record associated with it. Note that this DOI refers to the package as such and always forwards to the most current version.

https://zenodo.org/badge/DOI/10.5281/zenodo.4896687.svg

Where to start

Users new to the cwepr package should probably start at the beginning, those familiar with its underlying concepts may jump straight to the section explaining frequent use cases.

Those interested in a hands-on primer on cw-EPR spectroscopy, covering necessary information for how to obtain usable data with your cw-EPR spectrometer, may have a look at the cw-EPR primer.

The API documentation is the definite source of information for developers, besides having a look at the source code.

Installation

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

pip install cwepr

Have a look at the more detailed installation instructions as well.

Indices and tables

License

This program is free software: you can redistribute it and/or modify it under the terms of the BSD License. However, if you use the cwepr package for your own research, please cite it appropriately. See How to cite for details.