Skip to main content

Package for handling cw-EPR data.

Project description

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

The cwEPR package provides tools for handling experimental data obtained using continuous-wave EPR (cwEPR) spectroscopy and is derived from the ASpecD framework. Due to inheriting from the ASpecD superclasses, 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:

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

For more general information on the cwepr package and for how to use it, see its documentation.

Features

A list of features, not all implemented yet but aimed at for the first public release (cwEPR 0.1):

  • Fully reproducible processing of cw-EPR data
  • Import of EPR data from diverse sources (Bruker ESP, EMX, Elexsys; Magnettech)
  • 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.

Target audience

The cwepr package addresses scientists working with cwEPR data (both, measured and calculated) on a daily base and concerned with reproducibility. Due to being based on the ASpecD framework, the cwepr package ensures reproducibility and—as much as possible—replicability of data processing, starting from recording data and ending with their final (graphical) representation, e.g., in a peer-reviewed publication. This is achieved by automatically creating a gap-less record of each operation performed on your data. If you do care about reproducibility and are looking for a system that helps you to achieve this goal, the cwepr package may well be interesting for you.

Installation

Install the package by running:

pip install cwepr

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cwepr, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size cwepr-0.2.0.tar.gz (3.7 MB) File type Source Python version None Upload date Hashes View
Filename, size cwepr-0.2.0-py3-none-any.whl (69.0 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page