Metrics API
===========

Metrics modules calculate observed and synthetic waveform values, transform
those values into residuals and scores, plan file-based metric runs, and plot
metric diagnostics.

.. contents:: On this page
   :local:
   :depth: 2

Package Entry Point
-------------------

.. automodule:: spatial_vtk.metrics
   :members:

Calculate
---------

.. automodule:: spatial_vtk.metrics.calculate.amplitudes
   :members:

.. automodule:: spatial_vtk.metrics.calculate.arrival_picks
   :members:

.. automodule:: spatial_vtk.metrics.calculate.bands
   :members:

.. automodule:: spatial_vtk.metrics.calculate.batch
   :members:

.. automodule:: spatial_vtk.metrics.calculate.enrich
   :members:

.. automodule:: spatial_vtk.metrics.calculate.gof
   :members:

.. automodule:: spatial_vtk.metrics.calculate.phasenet_adapter
   :members:

.. automodule:: spatial_vtk.metrics.calculate.records
   :members:

.. automodule:: spatial_vtk.metrics.calculate.spectra
   :members:

.. automodule:: spatial_vtk.metrics.calculate.summaries
   :members:

.. automodule:: spatial_vtk.metrics.calculate.transforms
   :members:

.. automodule:: spatial_vtk.metrics.calculate.waveforms
   :members:

Workflow
--------

.. automodule:: spatial_vtk.metrics.workflow.execution
   :members:

.. automodule:: spatial_vtk.metrics.workflow.outputs
   :members:

.. automodule:: spatial_vtk.metrics.workflow.run
   :members:

.. automodule:: spatial_vtk.metrics.workflow.slurm
   :members:
   :exclude-members: SlurmSettings

.. automodule:: spatial_vtk.metrics.workflow.tasks
   :members:

Plotting
--------

.. automodule:: spatial_vtk.metrics.plot.example_metric_plots
   :members:

.. automodule:: spatial_vtk.metrics.plot.model_comparison
   :members:

.. automodule:: spatial_vtk.metrics.plot.periods
   :members:

.. automodule:: spatial_vtk.metrics.plot.site_terms
   :members:

.. automodule:: spatial_vtk.metrics.plot.trends
   :members: