Docs_v1.0

docs/further_analysis.md

@@ -0,0 +1,92 @@
+# 
+
+## CoCliCo Workbench
+The **CoCliCo Workbench** is a prototype repository containing tutorials and exploratory tools for **Coastal Climate Core Services**. It enables users to conduct in-depth analyses using platform data, either **online** via Google Colab and Binder or **offline** by running the workbench locally.
+
+---
+
+## Coding Online in Google Colab or Binder
+
+You can explore the workbench directly in your browser:
+- **[Open in Google Colab](https://colab.research.google.com/github/openearth/coclico-workbench)**
+- **[Open in Binder](https://mybinder.org/v2/gh/openearth/coclico-workbench/update_repo_readme)**
+
+Binder uses the `environment.yml` file in the main directory to configure the required dependencies automatically.
+
+---
+
+## Coding Offline (Locally) in the Workbench Environment
+
+Follow these steps to install and use the **CoCliCo Workbench** locally:
+
+### 1. Install Dependencies
+- Install **GitHub Desktop**: [Download](https://desktop.github.com/)
+- Install **Mamba Package Manager** (Miniforge3): [Download](https://github.com/conda-forge/miniforge#mambaforge)
+
+### 2. Clone the Repository
+- Open GitHub Desktop and **clone the repository**:
+  - Click `Add` → `Clone repository` → `URL`
+  - Copy the **CoCliCo Workbench URL** from the green **Code** button
+  - Set the local path (e.g., `C:\Users\YourName\Documents\GitHub\coclico-workbench`)
+
+### 3. Set Up the Environment
+- Open **Miniforge Prompt** and navigate to the cloned repository:
+  ```sh
+  cd C:\Users\YourName\Documents\GitHub\coclico-workbench\coclicodata_env
+  ```
+- Create the software environment (**coclico**):
+  ```sh
+  mamba env create -f environment.yml
+  ```
+- Activate the environment:
+  ```sh
+  mamba activate coclico
+  ```
+- Verify the installation:
+  ```sh
+  mamba list
+  ```
+- If some **pip dependencies** were not installed, manually install them:
+  ```sh
+  pip install stactools-geoparquet-items odc-ui odc-stac odc-stats odc-algo odc-io odc-cloud[ASYNC] mapbox mapboxcli xstac
+  ```
+
+### 4. Run Jupyter Notebooks in VS Code
+- Install **VS Code**: [Download](https://code.visualstudio.com/)
+- Open VS Code and **select the cloned repository** as the working directory.
+- Open a notebook (e.g., `IPCC_AR5_AR6_comparison.ipynb`) and select the **coclico** kernel in the top right.
+- Run cells using `Shift + Enter`.
+
+---
+
+## Repository Structure
+
+The **CoCliCo Workbench** repository is structured as follows:
+
+- **exploratory_tools/**: In-depth user story analysis (e.g., comparisons with high-resolution data, sea-level rise scenarios).
+- **notebooks/** *(DEPRECATED)*: Legacy scripts from the early CoCliCo project phase.
+- **tutorials/**: Short guides on using the **CoCliCo Data repository (STAC)**.
+
+---
+
+## Contributing
+Interested in contributing? Check out the **[contributing guidelines](#)**. This project follows a **Code of Conduct**, and by contributing, you agree to abide by its terms.
+
+---
+
+## License
+The **CoCliCo Workbench** is licensed under the **GNU General Public License**.
+
+---
+
+## Credits
+The **CoCliCo Workbench** was created using **cookiecutter** and the **py-pkgs-cookiecutter template**.
+
+For any issues, reach out to **@EtienneKras, @mathvansoest, or @FlorisCalkoen**.
+
+---
+
+<div align="center">
+    <img src="../assets/logo1.png" width="150" alt="CoCliCo Logo">
+    <p><small>Copyright &copy; 2025 CoCliCo Services</small></p>
+</div>

docs/getting_started.md

@@ -0,0 +1,83 @@
+#
+
+## **Key Features**
+
+- **[Sea Level and Hazard Projections](Datasets.md/#sea-levels)**  – Access datasets on sea level rise, extreme surge levels, and coastal flooding.
+- **[Exposure and Vulnerability Assessments](Datasets.md/#exposure-and-vulnerability)** – Understand how populations and infrastructure are affected.
+- **[Risk and Adaptation Strategies](Datasets.md/#risk-and-adaptation)** – Explore cost-benefit analyses of coastal adaptation measures.
+- **Interactive Map Interface** – Pan, zoom, and activate data layers for a detailed spatial analysis.
+
+
+---
+
+## **First steps**
+
+Once you've accessed the CoCliCo platform, you'll be greeted with an interactive map and various tools to explore coastal climate data. This section will guide you through the key components of the interface, helping you navigate and use the platform effectively.
+
+---
+
+### **1. Main Interface Overview**
+
+The main interface consists of the following elements:
+
+- **Map Window** – The central area where you can visualize data layers and explore different locations.
+- **Sidebar Menu** – Access to datasets and background layers. Click on the layers you want to activate. 
+- **Active Data Layers** – Adjust map settings, filters, and toggle visualization options.
+- **Dashboard** - Save your analysis and scenarios in the Dashboard window for further analysis and comparison.
+- **Interactive Pop-ups** – Click on specific locations to display detailed data insights.
+
+**![Upload an image of the main interface here](assets/Tool/Main.png)**
+
+### **2. Activate Data Layers**
+
+To start your analysis, activate relevant data layers from the Sidebar Menu. These layers include sea level rise projections, coastal hazards, exposure, and adaptation strategies.
+
+1. Open a category from the **Sidebar Menu**
+**![Upload an image or GIF showing how to activate layers](assets/Tool/Sidebar.png)** 
+2. Toggle the desired layer to display it on the map.
+
+**![Upload an image or GIF showing how to activate layers](assets/Tool/layers.png)**
+
+### **3. Apply Filters**
+
+The platform allows you to refine your analysis using filters such as return periods, climate scenarios, and hazard thresholds.
+
+1. Click on the **Filters Panel**.
+2. Choose a **Scenario** (e.g., low-end or high-end sea level rise).
+3. Select a **Return Period** (e.g., 10-year, 100-year).
+4. Apply the filters to update the map visualization.
+
+**![Upload a screenshot or video demonstrating filters](assets/Tool/Filters.png)**
+
+### **4. Interact with data**
+
+- **Pan and Zoom** – Navigate across the map using your mouse or touch gestures.
+- **Click on a Location** – View detailed data insights through interactive pop-ups.
+- **Compare Layers** – Activate multiple layers to analyze overlapping datasets.
+
+**![Upload a GIF showing map interactions](assets/Tool/Exploring.png)**
+
+### **5. Compare**
+
+Users can save and compare results by exporting charts and datasets.
+
+1. Click on a location to open the **insights Pop-up**.
+2. Select **Add to Dashboard** to save it for later.
+3. Compare different locations in the Dashboard window.
+
+**![Upload a video or step-by-step image sequence for exporting](assets/Tool/dashboard.png)**
+
+---
+
+### **6. Accessing to raw data and examples**
+
+Now that you're familiar with navigating the interface, continue to [Undestanding the Data](Datasets.md) for deeper insights into dataset usage or go to [Further Analysis](further_analysis.md) if you want to create you own experiments with the raw data (Examples included in this section).
+
+---
+
+<div align="center">
+    <img src="/assets/logo1.png" width="150" alt="CoCliCo Logo">
+    <p><small>Copyright &copy; 2025 CoCliCo Services</small></p>
+</div>
+
+

docs/index.md

@@ -1,13 +1,8 @@
-```{include} ../README.md
-```
+---
+template: home.html
+title: Material for MkDocs
+social:
+  cards_layout_options:
+    title: Documentation that simply works
+---
 
-```{toctree}
-:maxdepth: 1
-:hidden:
-
-example.ipynb
-changelog.md
-contributing.md
-conduct.md
-autoapi/index
-```