Merge pull request #83 from EOPF-Sample-Service/dev

Merge latest changes

Author: clausmichele

.github/workflows/deploy.yml

@@ -6,7 +6,6 @@ on:
   push:
     # Runs on pushes targeting the default branch
     branches: [main]
-    paths: ["notebooks/**"]
 env:
   # `BASE_URL` determines the website is served from, including CSS & JS assets
   # You may need to change this to `BASE_URL: ''`
@@ -46,13 +45,14 @@ jobs:
           condarc: |
             channels:
               - conda-forge
+      - name: Generate gallery
+        run: python generate_gallery.py
       - name: Execute Jupyter Notebooks and Build HTML Assets
         run: myst build --html --execute
-        working-directory: notebooks
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: "./notebooks/_build/html"
+          path: "./_build/html"
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4

CONTRIBUTING.md

@@ -46,10 +46,12 @@ This document outlines the process for creating, reviewing, and publishing sampl
   - Used for managing dataset requirements and conversions (e.g., to Zarr format).
 
 ### 2. Notebook Development Workflow
+
 #### 2.1 Issue Creation
 
 For each notebook to be developed, create a new GitHub Issue in the eopf-sample-notebooks repository.
 The issue must include:
+
 - A clear description of the notebook’s purpose and expected content.
 - Assignment of a responsible contributor.
 
@@ -62,33 +64,43 @@ The assigned contributor must:
 3. Create a corresponding Issue in the `eopf-sample-data` repository listing the datasets to be prepared and converted to Zarr format.
 
 #### 2.3 Notebook Implementation
-##### 2.3.1 Data Availability  
+
+##### 2.3.1 Data Availability
+
 - Notebook development should begin after the necessary data is available in the required format (Zarr).
 
-##### 2.3.2 Template Compliance  
+##### 2.3.2 Template Compliance
+
 - All notebooks must adhere to the [standardized template](https://github.com/EOPF-Sample-Service/eopf-sample-notebooks/blob/main/notebooks/template/template.ipynb).
 - The template ensures consistency in structure, formatting and metadata.
 - Contributors should refer to the existing notebooks available in the repository before starting implementation.
 
-##### 2.3.3 Python Environment  
+##### 2.3.3 Python Environment
+
 If you are using Python libraries which are not yet available in the [conda environment available here](https://github.com/EOPF-Sample-Service/eopf-sample-notebooks/blob/main/environment.yml), add them in the `environment.yml` and test if the conda environment can be created successfully. If the environment has to be updated, please mention it in the [eopf-container-images](https://github.com/EOPF-Sample-Service/eopf-container-images) repository, so that the env available at https://jupyterhub.user.eopf.eodc.eu can also be updated and be ready to run the notebook.
 
-##### 2.3.4 MyST Rendering  
+##### 2.3.4 MyST Rendering
+
 Each notebook needs to have an entry in the [myst.yml](https://github.com/EOPF-Sample-Service/eopf-sample-notebooks/blob/main/notebooks/myst.yml) configuration file if you want it to be rendered as an html page. Please add a new row for your notebook before submitting the PR.
 
-##### 2.3.5 Submission  
+##### 2.3.5 Submission
+
 Once the implementation is complete:
+
 - Run the formatting checks as mentioned above.
 - Submit a Pull Request (PR) against the `/dev` branch.
 - Reference the original issue in the PR description.
 
 #### 2.4 Quality Assurance
+
 ##### 2.4.1. Automated Checks
+
 - GitHub Actions are configured to run:
- - Code formatting checks.
- - Code quality tests.
+- Code formatting checks.
+- Code quality tests.
 
 #### 2.5 Peer Review and Pre-Publication
+
 After passing automated checks, the notebook will be reviewed by the team.
 
 Once approved, the PR is merged into the `/dev` branch.
@@ -97,13 +109,14 @@ This triggers automatic deployment to the development preview site:
 https://dev-eopf-sample-notebooks.netlify.app/
 
 The development site allows:
+
 - Verification of notebook rendering.
 - Internal feedback and issue tracking.
 
 #### 2.6 Final Publication
+
 After all feedback have been addressed, merge the changes from the `/dev` branch into the `/main` branch.
 This publishes the notebook to the official GitHub Pages site:
 https://eopf-sample-service.github.io/eopf-sample-notebooks/
 
-
 We appreciate your contributions — happy coding! 🚀

README.md

@@ -19,4 +19,4 @@ Please refer to the [Contributing Guideline](CONTRIBUTING.md)
 ## STAC
 
 Discover the available sample datasets using the STAC Browser:
-https://stac.browser.user.eopf.eodc.eu 
+https://stac.browser.user.eopf.eodc.eu

environment.yml

@@ -3,7 +3,7 @@ channels:
   - conda-forge
 dependencies:
   - python=3.11
-  - xarray=2024.11.0
+  - xarray
   - xarray-eopf
   - folium
   - graphviz
@@ -19,6 +19,9 @@ dependencies:
   - jupyterlab-myst
   - python-graphviz
   - pystac-client
+  - zarr
+  - tqdm
+  - geopandas
+  - dask
+  - rioxarray
   - pip
-  - pip:
-      - eopf==2.5.5

eopf.yml

@@ -3,7 +3,7 @@ project:
   open_access: true
   license:
     content: CC-BY-4.0
-    code: MIT
+    code: Apache-2.0
 site:
   template: book-theme
   options: