.. das_ice documentation master file, created by
   sphinx-quickstart on Mon Aug 12 08:34:03 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

das_ice documentation
=============================

.. image:: https://img.shields.io/badge/license-GPLv3-blue.svg
   :target: https://gricad-gitlab.univ-grenoble-alpes.fr/mecaiceige/tools/lib_python/das_ice/-/blob/main/LICENSE?ref_type=heads

.. image:: https://gricad-gitlab.univ-grenoble-alpes.fr/mecaiceige/tools/lib_python/das_ice/badges/main/pipeline.svg
   :target: https://gricad-gitlab.univ-grenoble-alpes.fr/mecaiceige/tools/lib_python/das_ice/-/commits/main

.. image:: https://badge.fury.io/py/das_ice.svg
   :target: https://badge.fury.io/py/das_ice

.. image:: https://img.shields.io/website-up-down-green-red/http/shields.io.svg
   :target: https://xarray-well-ice-mecaiceige-tools-lib-python-a1d7b6168ff878b45d0.gricad-pages.univ-grenoble-alpes.fr/


This documentation provides the description of all function contained in `das_ice`. This package enables easy data processing for DAS mesurement.

Tutorials
---------

.. toctree::
   :maxdepth: 2

   Tutorials/QuickStart.ipynb
   
Matched-Field Processing
************************

.. toctree::
   :maxdepth: 2
   
   Tutorials/MFP_synthetic_case.ipynb
   Tutorials/MFPfast.ipynb
   Tutorials/MFP_synthetic_case_3D.ipynb

Events detection
****************
.. toctree::
   :maxdepth: 2
   
   Tutorials/Event_detection.ipynb

Functions API
-------------
.. toctree::
   :maxdepth: 0
   :numbered: 
   
   function_api


Contact
-------
:Author: Thomas Chauve
:Contact: thomas.chauve@univ-grenoble-alpes.fr

:Organization: `IGE <https://www.ige-grenoble.fr/>`_
:Status: This is a "work in progress"

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`