UVVisPy documentation

Welcome! This is the documentation for UVVisPy. For general information see its homepage.

UVVisPy is a Python package based on the ASpecD framework for processing and analysing optical spectra obtained using UVVis spectroscopy. It emphasises reproducibility and good scientific practice.

Features

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

  • fully reproducible processing of UVVis data

  • customisable plots

  • 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

Warning

UVVisPy is currently under active development and still considered in Alpha 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.

Installation

Install the package by running:

pip install uvvispy

This will install the version from the Python Package Index (PyPI). To get the latest development version, clone the repository from GitHub and install it locally. In any case, it is highly recommended to use virtual environments to separate dependencies.

Where to start

Users new to UVVisPy should probably start at the beginning, those familiar with its underlying concepts an planning to help in further developing may jump straight to the section explaining how to contribute to the development of UVVisPy.

The API documentation is the definite source of information for developers, besides having a look at the source code.

Indices and tables