SQR-019 LSST Verification Framework API Demonstration
This technote describes, in a tutorial style, the lsst.verify API. This Verification Framework enables the LSST organization to define performance metrics, measure those metrics in Pipeline code, export metrics to a monitoring dashboard, and test performance against specifications.
Build this technical note
You can clone this repository and build the technote locally with Sphinx
git clone https://github.com/lsst-sqre/sqr-019 cd sqr-019 pip install -r requirements.txt make html
In a Conda environment,
pip install -r requirements.txt doesn't work as expected.
pip install the packages listed in
The built technote is located at
Editing this technical note
You can edit the
index.rst file, which is a reStructuredText document.
The DM reStructuredText Style Guide is a good resource for how we write reStructuredText.
Remember that images and other types of assets should be stored in the
_static/ directory of this repository.
_static/README.rst for more information.
This technote's metadata is maintained in
In this metadata you can edit the technote's title, authors, publication date, etc..
metadata.yaml is self-documenting with inline comments.
Copyright 2017 AURA/LSST
This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/.