.. _examples:

Examples
========

Below are links to a variety of example workflows help you get started with using
SeisBench to optimise your ML workflows.

.. _dataset_basics:

Dataset basics
--------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/01a_dataset_basics.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

An introduction to the SeisBench dataset API.


.. _model_basics:

Model basics
------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/01b_model_api.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

Get orientated with SeisBench models, learning how to load them and deploy to seismic streams.


.. _generator_pipelines:

Generator pipelines
-------------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/01c_generator_pipelines.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

Use the in-built generator functionality in SeisBench to enhance your ML processing workflows.


.. _applied_stream_picking:

Deploy ML pickers
-----------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/02a_deploy_model_on_streams_example.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

Rapidly deploy ML models integrated in SeisBench to seismic streams.


.. _using_deep_denoiser:

Using DeepDenoiser
------------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/02b_deep_denoiser.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

Denoising seismic waveform streams with DeepDenoiser in SeisBench.

.. _depth_phases:

Picking depth phases and determining earthquake depth
-----------------------------------------------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/02c_depth_phases.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

Determining earthquake hypocentral depth using depth phase in SeisBench.

.. _training_phasenet:

Training ML models on seismic data
----------------------------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/03a_training_phasenet.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

Get started with training deep learning routines (PhaseNet) on a benchmark seismic dataset in SeisBench.

.. _training_denoiser:

Training Denoiser models
------------------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/03e_training_denoiser.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

Learn how to train a Denoiser model on a SeisBench dataset and create a noise dataset from continuous seismic data.


.. _creating_a_dataset:

Creating a dataset
------------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/03b_creating_a_dataset.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

Learn how to create a dataset in SeisBench, using build-in functions and the obspy FDSN client as data source.

Building an event catalog with GaMMA
------------------------------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/03c_catalog_seisbench_gamma.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

Learn how to create an event catalog from raw waveforms and the metadata using SeisBench and the GaMMA associator.


Building an event catalog with PyOcto
-------------------------------------
.. raw:: html

    <embed>
        <a href="https://colab.research.google.com/github/seisbench/seisbench/blob/main/examples/03d_catalog_seisbench_pyocto.ipynb">
            <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
        </a>
    </embed>

Learn how to create an event catalog from raw waveforms and the metadata using SeisBench and the PyOcto associator.