Coverage for python/lsst/analysis/tools/__init__.py: 100%
3 statements
« prev ^ index » next coverage.py v7.2.5, created at 2023-05-05 04:41 -0700
« prev ^ index » next coverage.py v7.2.5, created at 2023-05-05 04:41 -0700
1# This file is part of analysis_tools.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
21r"""This packages contains various analysis tools and PipelineTasks which
22run them.
24There are two types of primary tools within this package; `AnalysisMetrics
25and `AnalysisPlots`, both of which are specialized subclasses of `AnalysisTool`.
27`AnalysisTool`\ s are objects that have three stages; prep, process, and
28post-process. Creating a new `AnalysisTool` is the process of choosing (though
29configuration) what `AnalysisAction` will run for each of those stages.
31`AnalysisTool`\ s and `AnalysisAction`\ s are subclasses of
32`~lsst.pex.config.configurableActions.ConfigurableAction`\ s. These objects are
33special types that are configured _prior_ to any code execution, and behave as
34functions at runtime. The configuration state of a
35`~lsst.pex.config.configurableActions.ConfigurableAction` is saved separately
36from the object itself, which allows
37"""
39from .statistics import *
40from .version import * # Generated by sconsUtils