Welcome! This is the documentation for trEPR, a Python package for processing and analysis of time-resolved electron paramagnetic resonance (tr-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 trepr 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
format: type: ASpecD recipe version: '0.2' settings: default_package: trepr datasets: - /path/to/first/dataset - /path/to/second/dataset tasks: - kind: processing type: PretriggerOffsetCompensation - kind: processing type: BackgroundCorrection properties: parameters: num_profiles: [10, 10] - kind: singleplot type: SinglePlotter2D 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.
A list of features:
Fully reproducible processing of tr-EPR data
Import and export of data from and to different formats
Automatically generated reports
Recipe-driven data analysis, allowing tasks to be performed fully unattended in the background and without programming skills
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
The trepr 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¶
trepr is free software. However, if you use trepr for your own research, please cite it appropriately:
Jara Popp, Mirjam Schröder, Till Biskup. trepr (2021). doi:10.5281/zenodo.4897112
To make things easier, trepr 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.
Where to start¶
Users new to the trepr package should probably start at the beginning, those familiar with its underlying concepts may jump straight to the section explaining frequent use cases.
The API documentation is the definite source of information for developers, besides having a look at the source code.
To install the trepr package on your computer (sensibly within a Python virtual environment), open a terminal (activate your virtual environment), and type in the following:
pip install trepr
Have a look at the more detailed installation instructions as well.
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 trepr package for your own research, please cite it appropriately. See How to cite for details.
A note on the logo¶
The snake (a python) resembles the lines of a tr-EPR spectrum, most probably a light-induced spin-polarised triplet state. The copyright of the logo belongs to J. Popp.