Framework for handling spectroscopic data.
Project description
ASpecD is a framework for handling spectroscopic data focussing on reproducibility. In short: Each and every processing step applied to your data will be recorded and can be traced back, and additionally, for each representation of your data (e.g., figures, tables) you can easily follow how the data shown have been processed and where they originate from.
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? Here is an example:
format: type: ASpecD recipe version: '0.3' datasets: - /path/to/first/dataset - /path/to/second/dataset tasks: - kind: processing type: BaselineCorrection properties: parameters: kind: polynomial order: 0 - kind: singleplot type: SinglePlotter1D properties: filename: - first-dataset.pdf - second-dataset.pdf
Save this recipe to a file, e.g., my-first-recipe.yaml. Cooking the recipe and serving the result is the matter of issuing a single command in a terminal:
serve my-first-recipe.yaml
This will do two things: process your data (and create the plots in our case) and write a full and gap-less history as an executable recipe.
For more general information on the ASpecD framework see its homepage, and for how to use it, its documentation.
Features
A list of features:
Framework for writing applications handling spectroscopic data
Consistent handling of numeric data and corresponding metadata
History of each processing step, automatically generated, aiming at full reproducibility
Undo and redo of processing steps
Import and export of 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 without programming skills
And to make it even more convenient for users and future-proof:
Open source project written in Python (>= 3.7)
Developed fully test-driven
Target audience
The ASpecD framework addresses every scientist working with data (both, measured and calculated) on a daily base and concerned with reproducibility. The ASpecD framework 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, ASpecD may well be interesting for you.
How to cite
ASpecD is free software. However, if you use ASpecD for your own research, please cite both, the article describing it and the software itself:
Jara Popp, Till Biskup. ASpecD: A Modular Framework for the Analysis of Spectroscopic Data Focussing on Reproducibility and Good Scientific Practice. Chemistry–Methods 2:e202100097, 2022. doi:10.1002/cmtd.202100097
Till Biskup. ASpecD (2022). doi:10.5281/zenodo.4717937
To make things easier, ASpecD 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.
License
This program is free software: you can redistribute it and/or modify it under the terms of the BSD License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file aspecd-0.12.0.tar.gz
.
File metadata
- Download URL: aspecd-0.12.0.tar.gz
- Upload date:
- Size: 1.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bbc4605e799dbee88f9c9b06666bcd7a4378bd188a3f89c93cab76a70660fd7 |
|
MD5 | ed51128cfb7b052ed37269f186653ec2 |
|
BLAKE2b-256 | 7cdcce529d6650065e920f8d07a5dfcfb0521a077eabcd448584d94dd9561f7c |
File details
Details for the file aspecd-0.12.0-py3-none-any.whl
.
File metadata
- Download URL: aspecd-0.12.0-py3-none-any.whl
- Upload date:
- Size: 252.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7123b60ab890829367910f7bebf5709c5e49b30d7daeda4bb1d69a196a8d22ae |
|
MD5 | fdb60724be8863fdd5bb4df7d3ec787c |
|
BLAKE2b-256 | 858cd59e1906b886b5c6029acf45c0979b7ebbfc9eee853ac6038ab1d7a5c99d |