.. _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