DM-9530: Initial metric and specification layout design

.github/contributing.md

@@ -0,0 +1,16 @@
+# How to contribute
+
+Thanks for your interest in making this package better! Here's how.
+
+## Getting help and reporting bugs
+
+If you're not part of the LSST Project, please post your question or issue in [our support forum](https://community.lsst.org/c/support). 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 `QA` component.
+
+## Contributing code
+
+Follow [LSST Data Management's workflow](https://developer.lsst.io/processes/workflow.html) for code contributions.

.github/issue_template.md

@@ -0,0 +1,7 @@
+Thanks for starting a new issue, but hold on!
+
+Please post your issue/bug report/feature request in the LSST Community support forum instead:
+
+https://community.lsst.org/c/support
+
+It's easy to create a forum account if you don't have one already.

.github/pull_request_template.md

@@ -0,0 +1,8 @@
+{Summary of changes. Prefix PR title with ticket handle.}
+
+****
+
+- [ ] Passes Jenkins CI.
+- [ ] Documentation is up-to-date.
+
+Preview the docs at: https://pipelines.lsst.io/v/DM-FIXME

.gitignore

@@ -0,0 +1,19 @@
+*.log
+*.json
+*.png
+*.pkl
+.sconsign.dblite
+.cache
+config.log
+.sconf_temp
+*.o
+*.os
+*.so
+*.cfgc
+*.pyc
+*_wrap.cc
+*Lib.py
+tests/.tests
+version.py
+bin/*.py
+examples/*.list

COPYRIGHT

@@ -0,0 +1 @@
+Copyright (C) 2017 Association of Universities for Research in Astronomy, Inc.

README.rst

@@ -2,4 +2,52 @@
 lsst.validate.metrics
 #####################
 
-**Centralized metric and specification definitions for the ``lsst.validate`` framework.**
+**Centralized metric and specification definitions for the lsst.validate framework.**
+
+For background on the ``lsst.validate`` framework, see SQR-017_.
+
+Registering metrics
+===================
+
+**Metrics** are *measureable things*.
+They can be astronomy concepts (an astrometric RMS), or computational (a task's timing or memory usage).
+
+Metrics that are measured by packages are **registered** here in ``validate_metrics`` by adding or extending a metric definition YAML file in the ``metrics/`` directory.
+See `metrics/README.rst <./metrics/README.rst>`_ for more information.
+
+Registering specifications
+==========================
+
+**Specifications** are tests of metric measurements.
+A specification might say that a metric measurement should be less than a certain value if that measurement was made under a certain set of conditions (*provenance*).
+Whenever metrics are measured, DM's SQUASH harness tests those measurements against specifications.
+Depending on the pass/fail outcome, subscribers can receive notifications (alerts).
+
+New specifications are **registered** here in ``validate_metrics`` by adding or extending a specification definition YAML file in the ``specs/`` directory.
+See `specs/README.rst <./specs/README.rst>`_ for more information.
+
+Getting help and reporting bugs
+===============================
+
+If you're not part of the LSST Project, please post your question or issue in `our support forum <https://community.lsst.org/c/support>`_.
+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.
+
+Contributing code
+=================
+
+Follow `LSST Data Management's workflow <https://developer.lsst.io/processes/workflow.html>`_ for code contributions.
+
+License
+=======
+
+This product includes software developed by the `LSST Project <http://www.lsst.org/>`_.
+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

SConstruct

@@ -0,0 +1,3 @@
+# -*- python -*-
+from lsst.sconsUtils import scripts
+scripts.BasicSConstruct("validate_metrics")

doc/.gitignore

@@ -0,0 +1,7 @@
+_build
+py-api
+api
+html
+*.tag
+*.inc
+doxygen.conf