lsst-sqre / sqr-017

Validation Metrics Framework

SQR-017 Validation Metrics Framework

This technote describes the design of the metric and specification system that the new validation framework will use.

View this technote at https://sqr-017.lsst.io or see a preview of the current version in this repo.

Build this technical note

You can clone this repository and build the technote locally with Sphinx

git clone https://github.com/lsst-sqre/sqr-017
cd sqr-017
pip install -r requirements.txt
make html

Note

In a Conda environment, pip install -r requirements.txt doesn't work as expected. Instead, pip install the packages listed in requirements.txt individually.

The built technote is located at _build/html/index.html.

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. See _static/README.rst for more information.

The published technote at https://sqr-017.lsst.io will be automatically rebuilt whenever you push your changes to the master branch on GitHub.

Updating metadata

This technote's metadata is maintained in metadata.yaml. 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/.