.. This file is generated by scripts/render_benchmark_docs.py. Do not edit by hand.

pyCSEP
======

Overview
--------

The current pyCSEP alignment is implemented as a report export contract inside the shared earthquake benchmark rather than as a standalone benchmark family.

It documents the forecasting artifact shape used by the WaveCastNet smoke config.

At a Glance
-----------

.. grid:: 1 2 4 4
   :gutter: 2
   :class-container: catalog-grid

   .. grid-item-card:: Kind
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         Ecosystem

      .. container:: catalog-stat-note

         Family benchmark or external ecosystem view.

   .. grid-item-card:: Hazard Family
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         Earthquake

      .. container:: catalog-stat-note

         Public hazard grouping used on the benchmark index page.

   .. grid-item-card:: Support Status
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         :bdg-info:`Synthetic-backed`

      .. container:: catalog-stat-note

         Current maturity of the adapter or evaluator path.

   .. grid-item-card:: Linked Models
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         1

      .. container:: catalog-stat-note

         1 model


Benchmark Mapping
-----------------

**Shared benchmark key:** ``earthquake``

**Registered class:** ``EarthquakeBenchmark``

Mapped benchmark family
~~~~~~~~~~~~~~~~~~~~~~~

:doc:`Earthquake Benchmark </benchmarks/earthquake_benchmark>`

Primary Source
~~~~~~~~~~~~~~

`pyCSEP <https://github.com/SCECCode/pycsep>`_.

.. dropdown:: Supported Tasks
   :class-container: catalog-dropdown

   - Wavefield Forecasting

.. dropdown:: Key Metrics
   :class-container: catalog-dropdown

   - ``mae``
   - ``mse``

.. dropdown:: Smoke Configs
   :class-container: catalog-dropdown

   - ``wavecastnet_benchmark_smoke.yaml``

.. dropdown:: Linked Models
   :class-container: catalog-dropdown

   :doc:`WaveCastNet </modules/models_wavecastnet>`.

.. dropdown:: Notes
   :class-container: catalog-dropdown

   - Current repo support is report-export alignment, not a separate pyCSEP benchmark runner.