You're reading an old version of this documentation. For up-to-date information, please have a look at v0.11.

Overview

Here, we present a (growing) series of working examples of how to use the ASpecD framework to perform both, day-to-day routine tasks in a laboratory as well as more complex processing and analysis tasks. For a more general introduction to working with recipes and recipe-driven data analysis, see the Use cases section.

Note

Generally, the ASpecD framework provides the solid ground for derived packages dedicated to particular (spectroscopic) methods, such as cw-EPR, tr-EPR, and UV/Vis. However, you can use ASpecD for certain tasks out of the box, at least for basic processing, analysis, and plotting, although all the advantages of tailor-made metadata for specific methods are lacking in this case.

For each of the examples, a full recipe is provided ready to be copied and pasted and run on your local computer.

Note

Some of the recipes require real example data that can be found in the accompanying repository on GitHub. Therefore, you can download the data and recipe to get first-hand experience with the ASpecD framework.

Prerequisites

To be able to run the example recipes locally, you need to have a working installation of the ASpecD framework and its dependencies. Have a look at the installation instructions for details.

Furthermore, to be able to run (“cook”) the recipes and get (“serve”) the results, you need to have access to a command line, as running recipes (still) is command-line based using the command serve recipe.yaml.

Further examples

If you are interested in more examples, the publication describing the cwepr package contains a number of examples of different complexity. The complete recipes are provided in the supporting information (SI). What is even better: You can download the entire set of data and corresponding recipes from GitHub: