diff --git a/.vitepress/config.mjs b/.vitepress/config.mjs index 8422a815..b7b200c0 100644 --- a/.vitepress/config.mjs +++ b/.vitepress/config.mjs @@ -108,7 +108,7 @@ const sideBar = withSidebar( ) const trainingSection = sideBar.themeConfig.sidebar.find(section => section.text === 'Training and Resources') -trainingSection.items.push({ text: 'Examples', link: 'https://esa-earthcode.github.io/examples/' }) +trainingSection.items.push({ text: 'Examples', link: 'https://esa-earthcode.github.io/tutorials/' }) sideBar.themeConfig.sidebar.forEach(group => { group.collapsed = true; diff --git a/pages/Community and Best Practices/FAIR and Open Science Best Practices/Data.md b/pages/Community and Best Practices/FAIR and Open Science Best Practices/Data.md index febc7bd8..3e5b1857 100644 --- a/pages/Community and Best Practices/FAIR and Open Science Best Practices/Data.md +++ b/pages/Community and Best Practices/FAIR and Open Science Best Practices/Data.md @@ -48,11 +48,11 @@ Use this checklist to prepare your Product for publication in EarthCODE. '[Prepare your data for publication](./Data#interoperability); ideally use cloud‑native formats. Add Set CRS, nodata, units; tune tiles/chunks and attach metadata to your data as appropriate - following the [Best Practice guide for data](../../Code%20Data%20and%20Workflow%20Quality.md)', 'Choose a [license for your data](./Data#open-data-licensing)', 'Plan for long term storage of your data - either on the [ESA PRR (default) or an external repository](./Data.md#storage-repositories); if you are using the ESA PRR, prepare your data following the [PRR upload guide and examples](../../Technical%20Documentation/ESA%20Project%20Results%20Repository%20/Uploading%20To%20PRR)', - 'Check if your project [already exists in the OSC](https://opensciencedata.esa.int/projects/catalog); if not, prepare the project information about the status, name, description, website(s), consortium, start/end dates, technical officer & email, themes and create it as described in [Adding a New Project](https://esa-earthcode.github.io/examples/osc-pr-manual/#id-2-1-add-new-project)', + 'Check if your project [already exists in the OSC](https://opensciencedata.esa.int/projects/catalog); if not, prepare the project information about the status, name, description, website(s), consortium, start/end dates, technical officer & email, themes and create it as described in [Adding a New Project](https://esa-earthcode.github.io/tutorials/osc-pr-manual/#id-2-1-add-new-project)', 'Select the geophysical variable(s) describing your dataset from the OSC [Variables](https://opensciencedata.esa.int/variables/catalog) and [CF name & units](./Data#choosing-the-right-variable-name)', 'Select the correct OSC [Themes](https://opensciencedata.esa.int/themes/catalog) and [Missions](https://opensciencedata.esa.int/eo-missions/catalog)', 'Consider if you want a [DOI from EarthCODE](./Data#doi-assignment) or if you would like to bring your own DOI', - 'Read the [Publishing Guide](../../../Technical%20Documentation/Open%20Science%20Catalog/Contributing%20to%20the%20Open%20Science%20Catalog.md) and checkout [example for publishing to the Open Science Catalog](https://esa-earthcode.github.io/examples/index-2/)', + 'Read the [Publishing Guide](../../../Technical%20Documentation/Open%20Science%20Catalog/Contributing%20to%20the%20Open%20Science%20Catalog.md) and checkout [example for publishing to the Open Science Catalog](https://esa-earthcode.github.io/tutorials/index-2/)', 'Post on the [EarthCODE forum](https://discourse-earthcode.eox.at/latest) about the new data product! ' ]" storage-key="earthcode-product" diff --git a/pages/Community and Best Practices/FAIR and Open Science Best Practices/Workflows.md b/pages/Community and Best Practices/FAIR and Open Science Best Practices/Workflows.md index 36e8993d..99c7b29d 100644 --- a/pages/Community and Best Practices/FAIR and Open Science Best Practices/Workflows.md +++ b/pages/Community and Best Practices/FAIR and Open Science Best Practices/Workflows.md @@ -59,7 +59,7 @@ Use this checklist to prepare your Product for publication in EarthCODE. 'Declare related ESA Project (or create one if missing in the [OSC Project Catalog](https://opensciencedata.esa.int/projects/catalog))', 'Select the relevant OSC [Variables](https://opensciencedata.esa.int/variables/catalog), [Themes](https://opensciencedata.esa.int/themes/catalog), and [Missions](https://opensciencedata.esa.int/eo-missions/catalog)', 'Consider if you want a [DOI from EarthCODE](./Workflows.md#doi-assignment) or if you bring an existing DOI', - 'Read the [Publishing Guide](../../../Technical%20Documentation/Open%20Science%20Catalog/Contributing%20to%20the%20Open%20Science%20Catalog.md) and look at [workflow examples](https://esa-earthcode.github.io/examples/osc-pr-pystac/#create-a-metadata-collection-for-new-workflow)', + 'Read the [Publishing Guide](../../../Technical%20Documentation/Open%20Science%20Catalog/Contributing%20to%20the%20Open%20Science%20Catalog.md) and look at [workflow examples](https://esa-earthcode.github.io/tutorials/osc-pr-pystac/#create-a-metadata-collection-for-new-workflow)', 'Document inputs and outputs — ideally by linking to an [Experiment](./Experiments.md)', 'Announce your new workflow on the [EarthCODE forum](https://discourse-earthcode.eox.at/latest)' ]" diff --git a/pages/Getting started with EarthCODE/10 minutes to EarthCODE.md b/pages/Getting started with EarthCODE/10 minutes to EarthCODE.md index 5532645f..e80fac70 100644 --- a/pages/Getting started with EarthCODE/10 minutes to EarthCODE.md +++ b/pages/Getting started with EarthCODE/10 minutes to EarthCODE.md @@ -9,7 +9,7 @@ This quick-start guide is designed to help you begin working with EarthCODE in j ## What is EarthCODE? EarthCODE is a strategic initiative by the **European Space Agency (ESA)** designed to empower researchers in Earth System Science with FAIR tools and infrastructure, sponsored EO cloud platforms and cloud services: 1. You can **access data, develop your workflows and run your experiments** on [integrated EO platforms](https://testing.earthcode.eox.at/computational-research). [Network of Resources (NoR)](https://nor-discover.org/) sponsored compute is also available. -2. You can **store results** in the [ESA Project Results repository (PRR)](https://esa-earthcode.github.io/examples/index-1/). +2. You can **store results** in the [ESA Project Results repository (PRR)](https://esa-earthcode.github.io/tutorials/index-1/). 3. You can **explore state-of-the-art data, workflows, and project information** available on the [Open Science Catalog](https://opensciencedata.esa.int/). You can also [publish](../Technical%20Documentation/Open%20Science%20Catalog/Contributing%20to%20the%20Open%20Science%20Catalog.md) your own data, workflows, and project information to it. 5. You can **engage** the EarthCODE and broader EO community [EarthCODE Forum](https://discourse-earthcode.eox.at/), which is directly connected to the catalog. @@ -160,7 +160,7 @@ Sometimes parts of the data and workflows are protected or private. Although not 3. Request to add them to the PRR via one of the three options described below. -See the [Contributing guide](../Technical%20Documentation/Open%20Science%20Catalog/Contributing%20to%20the%20Open%20Science%20Catalog.md) for a detailed exaplanation or go directly to the [examples](https://esa-earthcode.github.io/examples/index-2/). +See the [Contributing guide](../Technical%20Documentation/Open%20Science%20Catalog/Contributing%20to%20the%20Open%20Science%20Catalog.md) for a detailed exaplanation or go directly to the [examples](https://esa-earthcode.github.io/tutorials/index-2/). diff --git a/pages/Getting started with EarthCODE/Accessing EarthCODE.md b/pages/Getting started with EarthCODE/Accessing EarthCODE.md index 5cf3c62e..65d2f5c6 100644 --- a/pages/Getting started with EarthCODE/Accessing EarthCODE.md +++ b/pages/Getting started with EarthCODE/Accessing EarthCODE.md @@ -44,7 +44,7 @@ After creating an account and logging in, your next steps depend on the feature - [Integrated Platforms](../Technical%20Documentation/Platforms/) ## EarthCODE workspace -The [EarthCODE workspace](https://workspace.earthcode.eox.at) allows you to access to an integrated Jupyter Lab environment, in order for you to quickly get started with scientific research and experiments. You can also you it to access this documentation page and interactively run all [OSC and PRR examples](https://esa-earthcode.github.io/examples/). +The [EarthCODE workspace](https://workspace.earthcode.eox.at) allows you to access to an integrated Jupyter Lab environment, in order for you to quickly get started with scientific research and experiments. You can also you it to access this documentation page and interactively run all [OSC and PRR examples](https://esa-earthcode.github.io/tutorials/). Furthermore, the EarthCODE workspace offers you access to the Open Science Catalog Editor, a user-friendly tool which can be used to add, modify and delete the contents of the Open Science Catalog. It is a convenient helper which abstracts the complexity of working with the file structure of STAC catalogs. diff --git a/pages/Getting started with EarthCODE/Frequently Asked Questions.md b/pages/Getting started with EarthCODE/Frequently Asked Questions.md index a8fb29cf..855d7e23 100644 --- a/pages/Getting started with EarthCODE/Frequently Asked Questions.md +++ b/pages/Getting started with EarthCODE/Frequently Asked Questions.md @@ -15,7 +15,7 @@ This sub-section provides solutions to common issues that users may encounter.
How do I add entries to the Open Science Catalog? -Please check the [documentation](../Technical%20Documentation/Open%20Science%20Catalog/Contributing%20to%20the%20Open%20Science%20Catalog.md) or directly the [examples](https://esa-earthcode.github.io/examples/index-2/). +Please check the [documentation](../Technical%20Documentation/Open%20Science%20Catalog/Contributing%20to%20the%20Open%20Science%20Catalog.md) or directly the [examples](https://esa-earthcode.github.io/tutorials/index-2/).
@@ -46,7 +46,7 @@ Currently, this is decided on a case by case basis. Contact the EarthCODE team w
How do I upload my data to the PRR? -Please check the [documentation](../Technical%20Documentation/ESA%20Project%20Results%20Repository/index.md) or directly the [examples](https://esa-earthcode.github.io/examples/index-1/). +Please check the [documentation](../Technical%20Documentation/ESA%20Project%20Results%20Repository/index.md) or directly the [examples](https://esa-earthcode.github.io/tutorials/index-1/).
diff --git a/pages/Getting started with EarthCODE/index.md b/pages/Getting started with EarthCODE/index.md index 3a22a2de..99abacac 100644 --- a/pages/Getting started with EarthCODE/index.md +++ b/pages/Getting started with EarthCODE/index.md @@ -15,7 +15,7 @@ EarthCODE (Earth Science Collaborative Open Development Environment) provides th
  • You can store results in the - ESA Project Results repository (PRR). + ESA Project Results repository (PRR).
  • You can explore state-of-the-art data, workflows, and projects on the @@ -128,7 +128,7 @@ By exploring these sections, you’ll better understand how to leverage EarthCOD ### Tutorials -Explore the complete list of [Tutorials](../Training%20and%20Resources/) and [Examples](https://esa-earthcode.github.io/examples/) for a practical introduction EarthCODE and its related tools. +Explore the complete list of [Tutorials](../Training%20and%20Resources/) and [Examples](https://esa-earthcode.github.io/tutorials/) for a practical introduction EarthCODE and its related tools. ## Step 3: Who is EarthCODE For? diff --git a/pages/Integrating New Platforms to EarthCODE/User Documentation for Platforms Guide.md b/pages/Integrating New Platforms to EarthCODE/User Documentation for Platforms Guide.md index dbe3676c..52382400 100644 --- a/pages/Integrating New Platforms to EarthCODE/User Documentation for Platforms Guide.md +++ b/pages/Integrating New Platforms to EarthCODE/User Documentation for Platforms Guide.md @@ -111,7 +111,7 @@ and reference them in Markdown like so: ``` **Learn By Example** -Provide an example notebook/code in the [Examples](https://esa-earthcode.github.io/examples/) section of this guide through this repository: [https://github.com/ESA-EarthCODE/examples](https://github.com/ESA-EarthCODE/examples) +Provide an example notebook/code in the [Examples](https://esa-earthcode.github.io/tutorials/) section of this guide through this repository: [https://github.com/ESA-EarthCODE/examples](https://github.com/ESA-EarthCODE/examples) **Developing Workflows** diff --git a/pages/Technical Documentation/ESA Project Results Repository/Uploading To PRR.md b/pages/Technical Documentation/ESA Project Results Repository/Uploading To PRR.md index 4048c839..3384a5e5 100644 --- a/pages/Technical Documentation/ESA Project Results Repository/Uploading To PRR.md +++ b/pages/Technical Documentation/ESA Project Results Repository/Uploading To PRR.md @@ -12,4 +12,4 @@ In order to upload data to the ESA Project Results Repository (PRR) you have to **In the examples you will find guides to the whole process, code samples from other ESA projects, as well as instructions how to access data from and traverse the PRR**. We recomend starting with the introductory notebook. -- [PRR Examples](https://esa-earthcode.github.io/examples/index-1/) +- [PRR Examples](https://esa-earthcode.github.io/tutorials/index-1/) diff --git a/pages/Technical Documentation/ESA Project Results Repository/index.md b/pages/Technical Documentation/ESA Project Results Repository/index.md index e304ebce..98b72303 100644 --- a/pages/Technical Documentation/ESA Project Results Repository/index.md +++ b/pages/Technical Documentation/ESA Project Results Repository/index.md @@ -8,4 +8,4 @@ order: 1 The [ESA Project Results Repository (PRR)](https://eoresults.esa.int/) provides long term storage for research outcomes. It provides access to data, workflows, experiments and documentation from ESA Projects organised across Collections, accessible via the [STAC API](https://github.com/radiantearth/stac-api-spec). Each Collection contains [STAC Items](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md), with their related Assets stored within the PRR storage. Scientists/commercial companies can access the PRR via the [EarthCODE](https://earthcode.esa.int/) and [APEx](https://esa-apex.github.io/apex_documentation/) projects. -The [PRR examples page](https://esa-earthcode.github.io/examples/index-1/) provides executable introductions and a bank of examples of how different ESA projects organise their data. \ No newline at end of file +The [PRR examples page](https://esa-earthcode.github.io/tutorials/index-1/) provides executable introductions and a bank of examples of how different ESA projects organise their data. \ No newline at end of file diff --git a/pages/Technical Documentation/Open Science Catalog/Contributing to the Open Science Catalog.md b/pages/Technical Documentation/Open Science Catalog/Contributing to the Open Science Catalog.md index 945edeca..fe9746d2 100644 --- a/pages/Technical Documentation/Open Science Catalog/Contributing to the Open Science Catalog.md +++ b/pages/Technical Documentation/Open Science Catalog/Contributing to the Open Science Catalog.md @@ -77,9 +77,9 @@ The Open Science Catalog is built on the Spatio Temporal Asset Catalog (STAC), w - The [Open Science Catalog Editor](https://workspace.earthcode.eox.at/) is graphical user interface for automatically creating OSC entries and review requests. ### 2: Manual creation -- [Directly creating/editing STAC files](https://esa-earthcode.github.io/examples/osc-pr-manual/) - A guide for manually creating OSC entries. Requires knowledge of git. +- [Directly creating/editing STAC files](https://esa-earthcode.github.io/tutorials/osc-pr-manual/) - A guide for manually creating OSC entries. Requires knowledge of git. -- [Generating OSC files using pystac](https://esa-earthcode.github.io/examples/osc-pr-pystac/) - A guide for creating OSC entries using pystac. Requires knowledge of git and Python. +- [Generating OSC files using pystac](https://esa-earthcode.github.io/tutorials/osc-pr-pystac/) - A guide for creating OSC entries using pystac. Requires knowledge of git and Python. ### 3: Using platform tools and support - [DeepCode](https://github.com/deepesdl/deep-code) - An example using DeepCode: a library for automatically generating product entries for DeepESDL datasets. diff --git a/pages/Technical Documentation/Open Science Catalog/Open Science Catalog Overview.md b/pages/Technical Documentation/Open Science Catalog/Open Science Catalog Overview.md index e8de54a9..28061b01 100644 --- a/pages/Technical Documentation/Open Science Catalog/Open Science Catalog Overview.md +++ b/pages/Technical Documentation/Open Science Catalog/Open Science Catalog Overview.md @@ -25,7 +25,7 @@ The Open Science Catalog is a deployment of several EOEPCA components, in combin The Open Science Catalog metadata is a STAC catalog comprised of json files, with specific attributes and structure that together describe its elements - Themes, Variables, EO Missions, Projects, Products, Workflows, and Experiments. All files are stored directly on Github [here] (https://github.com/ESA-EarthCODE/open-science-catalog-metadata/tree/main), as they only contain metadata and links and not the actual data in the products, or the code in the workflows. -Detailed information about Projects, Products, Workflows, and Experiments is available in the tutorial which shows how to manually create files for the OSC - [here](https://esa-earthcode.github.io/examples/osc-pr-manual/) . +Detailed information about Projects, Products, Workflows, and Experiments is available in the tutorial which shows how to manually create files for the OSC - [here](https://esa-earthcode.github.io/tutorials/osc-pr-manual/) . ### Projects diff --git a/pages/Training and Resources/Tutorials and Learning Pathways.md b/pages/Training and Resources/Tutorials and Learning Pathways.md index 444f8a5d..5d34efc9 100644 --- a/pages/Training and Resources/Tutorials and Learning Pathways.md +++ b/pages/Training and Resources/Tutorials and Learning Pathways.md @@ -4,7 +4,7 @@ In this section, we highlight tutorials, learning pathways, and resources design ## Starting Point -The fastest way to gain value from EarthCODE is to first become familiar with its core capabilities by following the [Getting Started with EarthCODE guide](../Getting%20started%20with%20EarthCODE/). Once you understand your role and what EarthCODE can offer, you can explore the relevant guide or go directly to the [Examples Bank](https://esa-earthcode.github.io/examples/). Finding an example that closely matches your data, workflow, or problem is often the best starting point, as most examples are drawn from real-world projects. +The fastest way to gain value from EarthCODE is to first become familiar with its core capabilities by following the [Getting Started with EarthCODE guide](../Getting%20started%20with%20EarthCODE/). Once you understand your role and what EarthCODE can offer, you can explore the relevant guide or go directly to the [Examples Bank](https://esa-earthcode.github.io/tutorials/). Finding an example that closely matches your data, workflow, or problem is often the best starting point, as most examples are drawn from real-world projects. At any point during this process, you can engage in the forum and ask for help. If you are using a platform, you can also contact them directly. @@ -27,7 +27,7 @@ Furthermore, you can explore the following advanced materials: ### Examples -The [Examples Bank](https://esa-earthcode.github.io/examples/) will show you how to carry out a variety of tasks. All examples are based on actual use cases from other ESA projects and demonstrate how they are using EarthCODE. Currently, the focus is on publishing to the Open Science Catalog and uploading data to the ESA PRR, but the examples are continuously expanding. +The [Examples Bank](https://esa-earthcode.github.io/tutorials/) will show you how to carry out a variety of tasks. All examples are based on actual use cases from other ESA projects and demonstrate how they are using EarthCODE. Currently, the focus is on publishing to the Open Science Catalog and uploading data to the ESA PRR, but the examples are continuously expanding. All examples are runnable directly through the [EarthCODE workspace](https://workspace.earthcode.eox.at). diff --git a/pages/Training and Resources/index.md b/pages/Training and Resources/index.md index b70681a0..89d100ec 100644 --- a/pages/Training and Resources/index.md +++ b/pages/Training and Resources/index.md @@ -7,4 +7,4 @@ In the "Training and Resources" section, users will find everything they need to - [Tutorials](./Tutorials%20and%20Learning%20Pathways.md) - [Gallery](./Gallery.md) -- [Examples](https://esa-earthcode.github.io/examples/) +- [Examples](https://esa-earthcode.github.io/tutorials//)