Merge pull request #120 from QuentinMaz/feature/docs

Add documentation

docs/_toc.yml

@@ -14,9 +14,14 @@ parts:
       - file: tag_data
   - caption: Data preparation
     chapters:
+      - file: intro_data_preparation
       - file: s3_CMEMS_2D_kerchunk
       - file: s3_CMEMS_3D_kerchunk
       - file: s3chunked_parquet
+      - file: reference_model_creation
+      - file: tag_data_processing
+  - caption: Examples
+    chapters:
       - file: cmems_catalog_creation
       - file: gfts_intake
       - file: pannel_plot_s3

docs/cmems_catalog_creation.ipynb

@@ -5,7 +5,7 @@
    "id": "e2c0784b-1358-4926-827b-9808d153d39b",
    "metadata": {},
    "source": [
-    "# **Copernicus data exploration**\n",
+    "# Copernicus data exploration\n",
     "___\n",
     "#### In this notebook, we search for the different caracteristics of the required data from copernicus marine sevices in order to add them to a yaml file that will store all the uris for relevant products and help us improve how we access data from cmems.\n",
     "\n",
@@ -806,7 +806,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.8"
+   "version": "3.12.5"
   }
  },
  "nbformat": 4,

docs/intro_data_preparation.md

@@ -0,0 +1,16 @@
+# Introduction
+
+This subsection aims to detail the two types of data used in this project:
+
+1. _Reference models_, which refers to the data catalogs of the [Copernicus Service's services](https://www.copernicus.eu/en/copernicus-services) such as [CMEMS](https://marine.copernicus.eu/), the one we are the most interested by in `GFTS`.
+2. _Tag data_, that corresponds to any information and measurements from a tagged fish, ranging from the name of the tagging campaign to the temperature/pressure time series.
+
+Here a brief overview of what each section guides you through:
+
+- **_Create Kerchunk catalog for CMEMS_** and its **3D version** show how to build a reference model.
+- **_Read parquet kerchunk catalog_** illustrates how to load an already built reference model saved on the S3 bucket.
+- **_Create a Reference Model with `virtualizarr`_** presents another way for building reference models, this time with a recent library called `virtualizarr`.
+- One the other hand, **_Tag Data Preparation_** describes one way of processing raw tag data.
+- **_Copernicus data exploration_** and **_Reading CMEMS Copernicus data from GFTS s3 bucket_** illustrate how to wrap several reference models into a single [YAML intake catalog](https://intake.readthedocs.io/en/latest/catalog.html#yaml-format).
+
+The rest of the chapters focus on visualization of the different data.