lsst · leannep · Apr 24, 2021 · Apr 20, 2021 · Apr 20, 2021 · Apr 21, 2021
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
-# metric-pipeline-tasks
-Landing place for metric tasks that will be used in validation and verification.
+# lsst.faro
+
+lsst.faro is the new Gen3 middleware- and PipelineTask- based package for computing scientific performance metrics.
 
 See the README in the `tasks` directory for example usage.
diff --git a/doc/conf.py b/doc/conf.py
@@ -1,5 +1,5 @@
-"""Sphinx configuration file for an LSST stack package.
 
+"""Sphinx configuration file for an LSST stack package.
 This configuration only affects single-package Sphinx documentation builds.
 """
 

diff --git a/doc/index.rst b/doc/index.rst
@@ -9,6 +9,7 @@ faro documentation
 .. toctree::
    :maxdepth: 1
 
+   lsst.faro/index
    lsst.faro.base/index
    lsst.faro.measurement/index
    lsst.faro.preparation/index

diff --git a/...t/configs/lsst.faro.measurement.VisitMeasurement.VisitMeasurementTaskConfig.rst b/...t/configs/lsst.faro.measurement.VisitMeasurement.VisitMeasurementTaskConfig.rst
@@ -1,8 +1,8 @@
 .. lsst-config-topic:: lsst.faro.measurement.VisitMeasurement.VisitMeasurementTaskConfig
 
-###################
+##########################
 VisitMeasurementTaskConfig
-###################
+##########################
 
 .. _lsst.faro.measurement.VisitMeasurement.VisitMeasurementTaskConfig-configs:
 

diff --git a/...asurement/tasks/lsst.faro.measurement.PatchMeasurement.PatchMeasurementTask.rst b/...asurement/tasks/lsst.faro.measurement.PatchMeasurement.PatchMeasurementTask.rst
@@ -1,8 +1,8 @@
 .. lsst-task-topic:: lsst.faro.measurement.PatchMeasurement.PatchMeasurementTask
 
-#############
+####################
 PatchMeasurementTask
-#############
+####################
 
 .. _lsst.faro.measurement.PatchMeasurement.PatchMeasurementTask-api:
 

diff --git a/...paration.MatchedPreparationTasks.PatchMatchedMultiBandPreparationTaskConfig.rst b/...paration.MatchedPreparationTasks.PatchMatchedMultiBandPreparationTaskConfig.rst
@@ -1,8 +1,8 @@
 .. lsst-config-topic:: lsst.faro.preparation.MatchedPreparationTasks.PatchMatchedMultiBandPreparationTaskConfig
 
-###################################
+##########################################
 PatchMatchedMultiBandPreparationTaskConfig
-###################################
+##########################################
 
 .. _lsst.faro.preparation.MatchedPreparationTasks.PatchMatchedMultiBandPreparationTaskConfig-configs:
 

diff --git a/....faro.preparation.MatchedPreparationTasks.PatchMatchedPreparationTaskConfig.rst b/....faro.preparation.MatchedPreparationTasks.PatchMatchedPreparationTaskConfig.rst
@@ -1,8 +1,8 @@
 .. lsst-config-topic:: lsst.faro.preparation.MatchedPreparationTasks.PatchMatchedPreparationTaskConfig
 
-##########################
+#################################
 PatchMatchedPreparationTaskConfig
-##########################
+#################################
 
 .. _lsst.faro.preparation.MatchedPreparationTasks.PatchMatchedPreparationTaskConfig-configs:
 

diff --git a/....faro.preparation.MatchedPreparationTasks.TractMatchedPreparationTaskConfig.rst b/....faro.preparation.MatchedPreparationTasks.TractMatchedPreparationTaskConfig.rst
@@ -1,8 +1,8 @@
 .. lsst-config-topic:: lsst.faro.preparation.MatchedPreparationTasks.TractMatchedPreparationTaskConfig
 
-##########################
+#################################
 TractMatchedPreparationTaskConfig
-##########################
+#################################
 
 .. _lsst.faro.preparation.MatchedPreparationTasks.TractMatchedPreparationTaskConfig-configs:
 

diff --git a/...ro.preparation.MatchedPreparationTasks.PatchMatchedMultiBandPreparationTask.rst b/...ro.preparation.MatchedPreparationTasks.PatchMatchedMultiBandPreparationTask.rst
@@ -1,8 +1,8 @@
 .. lsst-task-topic:: lsst.faro.preparation.MatchedPreparationTasks.PatchMatchedMultiBandPreparationTask
 
-#############################
+####################################
 PatchMatchedMultiBandPreparationTask
-#############################
+####################################
 
 .. _lsst.faro.preparation.MatchedPreparationTasks.PatchMatchedMultiBandPreparationTask-api:
 

diff --git a/...s/lsst.faro.preparation.MatchedPreparationTasks.PatchMatchedPreparationTask.rst b/...s/lsst.faro.preparation.MatchedPreparationTasks.PatchMatchedPreparationTask.rst
@@ -1,8 +1,8 @@
 .. lsst-task-topic:: lsst.faro.preparation.MatchedPreparationTasks.PatchMatchedPreparationTask
 
-####################
+###########################
 PatchMatchedPreparationTask
-####################
+###########################
 
 .. _lsst.faro.preparation.MatchedPreparationTasks.PatchMatchedPreparationTask-api:
 

diff --git a/...s/lsst.faro.preparation.MatchedPreparationTasks.TractMatchedPreparationTask.rst b/...s/lsst.faro.preparation.MatchedPreparationTasks.TractMatchedPreparationTask.rst
@@ -1,8 +1,8 @@
 .. lsst-task-topic:: lsst.faro.preparation.MatchedPreparationTasks.TractMatchedPreparationTask
 
-####################
+###########################
 TractMatchedPreparationTask
-####################
+###########################
 
 .. _lsst.faro.preparation.MatchedPreparationTasks.TractMatchedPreparationTask-api:
 

diff --git a/doc/lsst.faro/design.rst b/doc/lsst.faro/design.rst
@@ -0,0 +1,50 @@
+.. _lsst.faro-design:
+
+.. py:currentmodule:: lsst.faro
+
+.. _lsst.faro-references:
+
+References and prior art
+========================
+
+``lsst.faro`` builds on
+ - The lsst.verify framework for computing data quality metrics,  described in `DMTN-098 <https://dmtn-098.lsst.io>`_ and `DMTN-057 <https://dmtn-057.lsst.io>`_
+
+ - The validate_drp package, the Gen2 middleware based code for computing KPMs, as described in `DMTN-008 <https://dmtn-008.lsst.io>`_
+
+.. _lsst.faro-design_goals:
+
+Design goals
+============
+
+Here we outline the architecture and design concepts of ``lsst.faro``
+
+- Enable the computation of scalar performance metrics for LSST
+
+- Gen3 based
+
+.. _lsst.faro-architecture:
+
+Architecture
+============
+
+``faro`` is based on the :ref:``lsst.verify`` framework for computing key performance metrics.
+
+
+.. _lsst.faro-package_organization:
+
+Organization of the faro package
+================================
+
+Directory structure
+-------------------
+
+- Preparation:  produces an intermediate data product
+- Measurement:  produces an lsst.verify.Measurement
+- Summary:  takes collection of lsst.verify.Measurement objects as input and produces an ``lsst.verify.Measurement``
+
+
+Naming conventions
+------------------
+
+
diff --git a/doc/lsst.faro/index.rst b/doc/lsst.faro/index.rst
@@ -0,0 +1,73 @@
+.. py:currentmodule:: lsst.faro
+
+.. _lsst.faro:
+
+#########
+lsst.faro
+#########
+
+.. toctree::
+
+The ``lsst.faro`` module contains code for computing scientific performance metrics on the outputs of the LSST science pipelines.
+
+Prior to the development of the Gen3 middleware, the Gen2-based  ``lsst.validate.drp`` package computed scientific performance metrics.
+``lsst.faro`` is the new Gen3 middleware- and PipelineTask- based package for computing scientific performance metrics.
+The algorithms implemented in ``validate_drp`` were ported as-is to run in ``lsst.faro``.
+``validate_drp`` is now deprecated; all future development of metrics will be carried out in ``lsst.faro``.
+
+.. _lsst.faro.design:
+
+Design and Development
+======================
+
+.. toctree::
+  :maxdepth: 1
+
+  design.rst
+
+.. _lsst.faro.using:
+
+Using faro
+==========
+
+.. toctree::
+  :maxdepth: 1
+
+  using.rst
+
+.. _lsst.faro.contributing:
+
+Contributing
+============
+
+``lsst.faro`` is developed at https://github.com/lsst/faro.
+You can find Jira issues for this module under the `faro <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20faro>`_ component.
+
+.. _lsst.faro.api-ref:
+
+Python API reference
+====================
+
+.. automodapi:: lsst.faro
+   :no-main-docstr:
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.faro.base
+   :no-main-docstr:
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.faro.preparation
+   :no-main-docstr:
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.faro.measurement
+   :no-main-docstr:
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.faro.summary
+   :no-main-docstr:
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.faro.utils
+   :no-main-docstr:
+   :no-inheritance-diagram:
diff --git a/doc/lsst.faro/using.rst b/doc/lsst.faro/using.rst
@@ -0,0 +1,33 @@
+.. _faro_using:
+
+.. py:currentmodule:: lsst.faro
+
+.. _lsst.faro.getting_started:
+
+Getting started
+===============
+
+If you are new to the LSST science pipelines, you should first install the LSST science pipelines following one of the methods described at The LSST Science Pipelines -- Installation (add link).
+
+.. _lsst.faro-running:
+
+Running faro
+============
+
+
+- Running and building ``lsst.faro`` locally.
+- Running faro on an reprocessed Gen3 repository at NCSA
+
+.. _lsst.faro-adding_a_metric:
+
+Adding a metric to faro
+=======================
+
+1. Identify the analysis context
+
+2. Implement Measurement task
+
+3. Implement unit tests
+
+4. Add to pipeline yaml file
+
diff --git a/doc/manifest.yaml b/doc/manifest.yaml
@@ -3,6 +3,7 @@
 # # List of names of Python modules in this package.
 # # For each module there is a corresponding module doc subdirectory.
 modules:
+  - "lsst.faro"
   - "lsst.faro.base"
   - "lsst.faro.measurement"
   - "lsst.faro.preparation"

diff --git a/python/lsst/__init__.py b/python/lsst/__init__.py
@@ -0,0 +1,2 @@
+import pkgutil
+__path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/python/lsst/faro/__init__.py b/python/lsst/faro/__init__.py
@@ -0,0 +1,2 @@
+import pkgutil
+__path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/tests/test_photKPM.py b/tests/test_photKPM.py
@@ -19,14 +19,22 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Unit tests for the metrics measurement system: PA1, PA2, PF1.
+"""Unit tests for the metrics measurement system: PA1, PF1.
 """
 
 import unittest
 import yaml
 import os
 import random
 
+from lsst.utils import getPackageDir
+from lsst.afw.table import SimpleCatalog
+from lsst.faro.measurement import PA1Task, PF1Task
+import unittest
+import yaml
+import os
+import random
+
 from lsst.utils import getPackageDir
 from lsst.afw.table import SimpleCatalog
 from lsst.faro.measurement import PA1Task, PF1Task