Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DM-10924: README improvements #7

Merged
merged 3 commits into from
Jun 14, 2017
Merged

DM-10924: README improvements #7

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f047001
Fix links in README
jonathansick Jun 14, 2017
073bd57
Mention lsst_distrib distribution in README
jonathansick Jun 14, 2017
000f4c3
Link to the SQR-019 demo technote.
jonathansick Jun 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ lsst.verify.metrics

**Centralized metric and specification definitions for the LSST Science Pipeline Verification Framework.**

For background on the ``lsst.verify`` framework, see SQR-017_.
For background on the ``lsst.verify`` framework, see the SQR-017_ (design) and SQR-019_ (demo) technotes.

Installation
============

This ``verify_metrics`` package is a dependency of the `verify`_ package, and available through the ``lsst_distrib`` top-level package.
See https://pipelines.lsst.io for details on installing ``lsst_distrib``.

Registering metrics
===================
Expand Down Expand Up @@ -35,7 +41,7 @@ It's easy to create a Community forum account.
*We don't use GitHub Issues.*

If you're part of the LSST Project, please create a `JIRA ticket <https://jira.lsstcorp.org/>`_.
Use the `Validation <https://jira.lsstcorp.org/browse/DM/component/13205>`_ component.
Use the `Verification component`_ component and `verify_metrics label`_.

Contributions
=============
Expand All @@ -54,4 +60,7 @@ See the `COPYRIGHT <./COPYRIGHT>`_ file.
This product's source code is licensed under the terms of GPLv3 (see `LICENSE <./LICENSE>`_), and all documentation content is licensed under the `Creative Commons Attribution 4.0 International (CC BY 4.0) <https://creativecommons.org/licenses/by/4.0/>`_ license.

.. _SQR-017: https://sqr-017.lsst.io
.. _verify: https://github.com/lsst-dm/verify
.. _SQR-019: https://sqr-019.lsst.io
.. _verify: https://github.com/lsst/verify
.. _Verification Component: https://jira.lsstcorp.org/browse/DM/component/14170
.. _`verify_metrics label`: https://jira.lsstcorp.org/issues/?jql=labels%20%3D%20verify_metrics