Skip to content

Commit

Permalink
docs: Re-wrote Concepts document.
Browse files Browse the repository at this point in the history
  • Loading branch information
pabloitu committed Sep 25, 2024
1 parent 4a8e76c commit ef32c94
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 33 deletions.
Binary file added docs/_static/float_scheme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 2 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Quickstart
| | - :ref:`case_b` |
| |learn2| **Testing Theory** | - :ref:`case_c` |
| | - :ref:`case_d` |
| |experiment| **Floating Experiments** | - :ref:`case_e` |
| |experiment| **Experiment Concepts** | - :ref:`case_e` |
| | - :ref:`case_f` |
| |api| **API Reference** | - :ref:`case_g` |
| | - :ref:`case_h` |
Expand All @@ -78,7 +78,6 @@ Goals

* Set up a testing experiment for your forecasts using authoritative data sources/benchmarks.
* Encapsulate the complete experiment's definition and rules in a couple of lines.
* Produce human-readable results and figures.
* Reproduce, reuse, and share forecasting experiments.

Running
Expand Down Expand Up @@ -137,8 +136,7 @@ Collaborators
:caption: Get Started

intro/installation.rst
intro/forecasting_experiments.rst
intro/floating_experiments.rst
intro/concepts.rst


.. toctree::
Expand Down
71 changes: 71 additions & 0 deletions docs/intro/concepts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
Concepts
========


Forecasting Models
-----------------------------

An earthquake **Forecasting Model** is a representation of our understanding of seismicity, constituted by a collection of hypotheses, assumptions, data and methods. It is able to generate **Forecasts**, i.e., `a probabilistic statement about the occurrence of seismicity, which can include information about its magnitude and spatial location` (Check out the `Core Concepts <https://docs.cseptesting.org/getting_started/core_concepts.html>`_ in the **pyCSEP** documentation).


From a computational perspective, a Model can be conceptualized as a **black-box system**, which receives an **input** (e.g. catalog, time window, target magnitude) to produce an **output** (a forecast). It may consist of a single Forecast, a collection of Forecasts, or a forecast-generating source-code. For now, we support earthquake forecasts expressed as:

* Mean rate of occurrence in spatial-magnitude-temporal discretizations
* Families of synthetic earthquake catalogs.


Forecasting Experiments
-----------------------

A **Forecasting Experiment** is here defined as the complete scientific process that encodes the questions, hypotheses to be addressed by **Forecasting Models** and the **Evaluation** of such hypotheses and their results.
An experiment has the purpose of leading eventually to scientific and methodological improvements in our forecasting capabilities.

In **Prospective Experiments**, the parameters of the experiment (including forecast generation, data sets, and evaluation metrics) must be defined with zero degrees of freedom before any evaluations begin. Prospective experimentation provides the most objective view of the forecast skill of a model, due to excluding any unconscious bias from the modelers. Examples of past prospective experiments are:

.. list-table::
:header-rows: 1
:widths: 12 90

* - Region
- References
* - California
- * `Schorlemmer, D., & Gerstenberger, M. (2007). RELM testing center. Seismological Research Letters, 78(1), 30-36. <https://doi.org/10.1785/gssrl.78.1.30>`_
* `Schorlemmer, D., et al. (2010). First results of the regional earthquake likelihood models experiment. Seismogenesis and Earthquake Forecasting: The Frank Evison Volume II, 5-22. <https://doi.org/10.1007/978-3-0346-0500-7_2>`_
* `Strader, A., et al. (2017). Prospective and retrospective evaluation of five-year earthquake forecast models for California. Geophysical Journal International, 211-1, 239–251. <https://doi.org/10.1093/gji/ggx268>`_
* - Japan
- * `Nanjo, K., et al. (2011). Overview of the first earthquake forecast testing experiment in Japan, Earth Planets Space, 63 (3), 159–169 <doi:10.5047/eps.2010.10.003>`_
* `Tsuruoka, H., et al., (2012). CSEP Testing Center and the first results of the earthquake forecast testing experiment in Japan. Earth, planets and space, 64, 661-671. <https://doi.org/10.5047/eps.2012.06.007>`_

* - New Zealand
- * `Gerstenberger, M., & Rhoades, D. (2010). New Zealand earthquake forecast testing centre. Seismogenesis and Earthquake Forecasting: The Frank Evison Volume II, 23-38. <https://doi.org/10.1007/978-3-0346-0500-7_3>`_
* `Rhoades, D., et al. (2018). Highlights from the first ten years of the New Zealand earthquake forecast testing center. Seismological Research Letters, 89(4), 1229-1237. <https://doi.org/10.1785/0220180032>`_
* - Italy
- * `Schorlemmer, D., et al. (2010). Setting up an earthquake forecast experiment in Italy. Annals of Geophysics. <https://doi.org/10.4401/ag-4844>`_
* `Taroni, M., et al. (2018). Prospective CSEP evaluation of 1‐day, 3‐month, and 5‐yr earthquake forecasts for Italy. Seismological Research Letters, 89(4), 1251-1261. <https://doi.org/10.1785/0220180031>`_
* `Iturrieta, P., et al. (2024). Evaluation of a Decade-Long Prospective Earthquake Forecasting Experiment in Italy. Seismological Research Letters. <https://doi.org/10.1785/0220230247>`_

Floating Experiments
--------------------

They are a new conceptual framework for modern experiments, whose operation rely on version control systems (i.e. ``git``), open-data repositories ((e.g. `Zenodo <https://zenodo.org>`_) and the containerization of computational environments (e.g., `Docker <https://docker.com>`_), making experiments reproducible, re-usable and shareable during the time scale of the evaluations. **Floating Experiments** are computational reproducibility packages (e.g., `World Bank <https://reproducibility.worldbank.org/>`_) expanded to a dynamic implementation, as new earthquake data becomes available in time and new testing results can be continuously released.

.. figure:: ../_static/float_scheme.png
:alt: Floating Experiments
:width: 50%
:align: center

The forecasting experiment is stored along with the system (**floatCSEP**) and testing routines (**pyCSEP**). It can be cloned to a local machine and run to create results, by using a containerized environment. Results can then be published back into the same repositories, tagging a version/release for each update.


**floatCSEP** assists scientists and institutions in the deployment of forecasting experiments, by standardizing and curating the artifacts and methods required to continuously run and/or reproduce an
experiment, without it being coupled to a fixed physical infrastructure.


References
----------

* Mizrahi, L., Dallo, I., van der Elst, N. J., Christophersen, A., Spassiani, I., Werner, M. J., et al. (2024). Developing, testing, and communicating earthquake forecasts: Current practices and future directions. Reviews of Geophysics, 62, e2023RG000823. https://doi.org/10.1029/2023RG000823
* Iturrieta, P., Savran, W. H., Khawaja, M. A. M., Bayona, J., Maechling, P. J., Silva, F., et al. (2023). Modernizing earthquake forecasting experiments: The CSEP floating experiments. In AGU Fall Meeting Abstracts (Vol. 2023).
* Savran, W. H., Bayona, J. A., Iturrieta, P., Asim, K. M., Bao, H., et al. (2022). pyCSEP: a Python toolkit for earthquake forecast developers. Seismological Society of America, 93(5), 2858-2870. https://doi.org/10.1785/0220220033
* Krafczyk, M. S., Shi, A., Bhaskar, A., Marinov, D., Stodden, V., (2021). Learning from reproducing computational results: Introducing three principles and the Reproduction Package. Philosophical Transactions of the Royal Society A: Mathematical, Physical and Engineering Sciences 379, 20200069. https://doi.org/10.1098/rsta.2020.0069.

24 changes: 0 additions & 24 deletions docs/intro/floating_experiments.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/intro/forecasting_experiments.rst

This file was deleted.

0 comments on commit ef32c94

Please sign in to comment.