Welcome! This is the documentation for UVVisPy, a Python package for processing and analysis of UV-visible (UVVis) 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 UVVisPy 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:
1default_package: uvvispy 2 3datasets: 4 - /path/to/first/dataset 5 - /path/to/second/dataset 6 7tasks: 8 - kind: processing 9 type: BaselineCorrection 10 properties: 11 parameters: 12 order: 0 13 - kind: singleplot 14 type: SinglePlotter1D 15 properties: 16 filename: 17 - first-dataset.pdf 18 - second-dataset.pdf
Interested in more real-live examples? Check out the use cases section.
A list of features:
fully reproducible processing and analysis of UVVis data
automatically generated reports
recipe-driven data analysis
And to make it even more convenient for users and future-proof:
Open source project written in Python (>= 3.5)
Developed fully test-driven
Extensive user and API documentation
UVVisPy 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¶
UVVisPy is free software. However, if you use UVVisPy for your own research, please cite it appropriately:
Till Biskup. UVVisPy (2021). doi:10.5281/zenodo.5106817
To make things easier, UVVisPy 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¶
The API documentation is the definite source of information for developers, besides having a look at the source code.
To install the UVVisPy package on your computer (sensibly within a Python virtual environment), open a terminal (activate your virtual environment), and type in the following:
pip install uvvispy
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 UVVisPy package for your own research, please cite it appropriately. See How to cite for details.
A note on the logo¶
The snake (a python) forms a prism that diffracts the incoming light. The copyright of the logo belongs to J. Popp.