Skip to content

Commit 0074b1b

Browse files
authored
Merge pull request #119 from ESA-EarthCODE/zoom-to-hover
Platform Documentation Update
2 parents 3224b9f + 8b30f95 commit 0074b1b

File tree

7 files changed

+554
-11
lines changed

7 files changed

+554
-11
lines changed

pages/Getting started with EarthCODE/10 minutes to EarthCODE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,9 @@ For detailed guide on best practices refer to the [Best Practices Page](../Commu
183183
EarthCODE integrates FAIR tools and standards at every stage of the research lifecycle to make FAIR the default—without extra effort from scientists.
184184

185185

186+
<!-- The key user persona (Figure 3) for EarthCODE is the earth observation scientist, for whom EarthCODE looks to provide capabilities such as: development and execution of workflows to capture large scale processes over climatic temporal scales; conducting complex multi-variate spatio-temporal analyses; running various analyses and models, including ML; setting up automated execution of algorithms, potentially recurrent; performing dataset and feature engineering; performing pipeline building and automation; accessing and processing heterogeneous data sources including online collections, data cubes and data at native resolution; having access to complete metadata for the datasets including data lineage and provenance, source and (pre-)processing; extracting, reading, writing and downloading data from APIs; storing, describing, publishing and documenting new data; using own data such as field measurements within scientific workflows; accessing the newest (EO) data available, programmatically; packaging, publishing and preserving the scientific outputs (data and code) with persistent identifiers (e.g., DOIs) in long-term storage repositories; setting up and using software environments; importing and running environments on EO Platforms; exporting environments (e.g. Docker, application package, openEO graph, etc) and sharing them; using Git, including provided by own organisation; managing versions of data, code and documentation; making projects/repositories citable; contributing to open source projects; publishing scientific results and other research outcomes on web, including scientific visualisations; discovering and exploring scientific results, data, code and documentation of other contributing researchers. -->
187+
188+
186189
| FAIR Tools | Description |
187190
|-------------------------------|-------------|
188191
| **Development** | EarthCODE provides integrated platforms that provide different options for developing scientific workflows |

pages/Getting started with EarthCODE/About.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,23 @@ EarthCODE ([earthcode.esa.int](https://earthcode.esa.int)) is ESA’s strategic
2929
Open Science is a movement to make the entire research process more accessible and reproducible, including input data, analysis methods, results, and the dissemination and reception of those results.
3030
:::
3131

32+
<!-- what is open science
33+
34+
Open science principles are increasingly being embraced in Earth sciences to promote transparency, collaboration, and accessibility of research. Commonly, these principles are being applied by promoting open access publications, preprints and an open review process, sharing data and methodologies openly for verification, reproducibility and reuse, embracing open-source principles in software development to allow others to inspect, modify, and contribute to the code, encouraging collaboration among researchers through various platforms like GitHub, GitLab and other collaborative tools, sharing educational resources openly to allow for a global audience, and by promoting citizen science.
35+
36+
37+
38+
Open Science is also creating global impact, as shown by the increasing number of resources on open science, and by the dedicated programmes and initiatives to promote open science adoption in the community (AGU, 2024), (Murphy, 2021), (P. J. Zellner et al., 2024). Policies and recommendations from international bodies (EU, 2020), (European Commission, 2021), (UNESCO, 2022), further aim to make the scientific process more transparent, accessible, and inclusive.
39+
40+
41+
42+
This global trend comes in the age of the cloud revolution, making advanced and resource hungry processing increasingly accessible, as researchers can discover, access and process huge amounts of Earth data from EO platforms, couple their analyses with models, and run complex workflows on powerful infrastructures that can scale and are accessed on demand, from the convenience of their desk.
43+
44+
45+
46+
Together, Open Science and EO platforms create huge opportunities for Earth System science. Still, there is significant complexity to consider. One good example of where common principles promoted by open science are insufficient for a cloud computing scenario is making available the dataset package for a publication, in which researchers should aim to make their data accessible for download in “1-click”. Consider the case of high-resolution global datasets produced by workflows executed on platforms that accesses cloud-optimized Earth Observation and other Earth data. Not only it is cost and resource ineffective to deliver this dataset for download, but it also hinders reproducibility and use, as its sole delivery, even with the accompanying code, is insufficient without the access to the infrastructure. Sustainable Open Science must account for the new complexities and requirements of the cloud-computing research era.
47+
-->
48+
3249
## The Roadmap
3350

3451
By aligning with FAIR principles and leveraging cloud infrastructure, EarthCODE promotes transparency, reproducibility, and collaboration in Earth System Science. the EarthCODE **roadmap** helps clarify how this transformation has unfolded—and where the platform is heading next:

pages/Getting started with EarthCODE/index.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,10 @@ There are two ways to explore EarthCODE:
3535
2. **Jump straight to what you need** – If you’re short on time or already familiar with EarthCODE, you can go directly to specific topics:
3636

3737
* [10 minutes to EarthCODE](./10%20minutes%20to%20EarthCODE.md) – A quick overview to get started fast
38-
* [Deep Dive into EarthCODE](./Deep%20Dive%20into%20EarthCODE.md) – Advanced features and in-depth guidance
3938
* [Accessing EarthCODE](./Accessing%20EarthCODE.md) – Accessing EarthCODE and Platforms
4039
* [Troubleshooting and Support](./Troubleshooting%20and%20Support.md) – Help when you need it
4140

42-
2. **Explore the EarthCODE Platform Ecosystem** – We have a growing ecosystem of platforms to provide [FAIR and Open Earth Observation science tools and infrastructure](../Technical%20Documentation/Platforms/index.md) to explore.
41+
3. **Explore the EarthCODE Platform Ecosystem** – We have a growing ecosystem of platforms to provide [FAIR and Open Earth Observation science tools and infrastructure](../Technical%20Documentation/Platforms/index.md) to explore.
4342

4443
<div style="display: flex; justify-content: center; align-items: center; gap: 2rem; flex-wrap: wrap; margin: 2rem 0;">
4544
<img src="/img/platforms/platform_logos/deepesdl.webp" alt="DeepESDL" style="max-height: 120px; object-fit: contain;" />
@@ -134,7 +133,9 @@ Explore the complete list of [Tutorials and other resources](../Training%20and%2
134133

135134

136135
## Step 3: Who is EarthCODE For?
137-
EarthCODE is designed for the community of Earth‑science practitioners, including ESRIN Science Hub members, the ESA Science Hub and teams working on ESA‑funded projects to enable them to do science and publish their results. It further serves as a place for developers and users to contribute workflows, platforms and discover openly available Earth Science research data and code. There are two key type of roles within EarthCODE:
136+
EarthCODE is designed for the community of Earth‑science practitioners, including ESRIN Science Hub members, the ESA Science Hub and teams working on ESA‑funded projects to enable them to do science and publish their results. A key stakeholder group are the ESA Science Clusters which aim at promoting networking, collaborative research, and fostering international collaboration in various Earth science domains, including: atmosphere, ocean, carbon, water cycle, polar, extremes and natural disasters, biosphere, land and agriculture, solid and magnetic earth. Clusters involve different ESA funded projects and activities bringing together expertise, data and resources in a synergistic manner.
137+
138+
There are two key type of roles within EarthCODE:
138139

139140
**Scientists**, EarthCODE is a platform to: Do science. Publish science. Discover data and code. Use other people’s data and code in an ethical manner. Discuss science. Collaborate on science. Learn about FAIR and Open Science.
140141

@@ -155,6 +156,39 @@ A few brief examples of how a climate scientist, ML developer, or EO analyst mig
155156
156157
make these clickable and expandable as well
157158
::: -->
159+
160+
<!--
161+
A key stakeholder group are the ESA Science Clusters which aim at promoting networking, collaborative research, and fostering international collaboration in various Earth science domains, including: atmosphere, ocean, carbon, water cycle, polar, extremes and natural disasters, biosphere, land and agriculture, solid and magnetic earth. Clusters involve different ESA funded projects and activities bringing together expertise, data and resources in a synergistic manner.
162+
163+
The key user persona (Figure 3) for EarthCODE is the earth
164+
observation scientist, for whom EarthCODE looks to provide
165+
capabilities such as: development and execution of workflows
166+
to capture large scale processes over climatic temporal scales;
167+
conducting complex multi-variate spatio-temporal analyses;
168+
running various analyses and models, including ML; setting up
169+
automated execution of algorithms, potentially recurrent;
170+
performing dataset and feature engineering; performing pipeline
171+
building and automation; accessing and processing
172+
heterogeneous data sources including online collections, data
173+
cubes and data at native resolution; having access to complete
174+
metadata for the datasets including data lineage and provenance,
175+
source and (pre-)processing; extracting, reading, writing and
176+
downloading data from APIs; storing, describing, publishing
177+
and documenting new data; using own data such as field
178+
measurements within scientific workflows; accessing the newest
179+
(EO) data available, programmatically; packaging, publishing
180+
and preserving the scientific outputs (data and code) with
181+
persistent identifiers (e.g., DOIs) in long-term storage
182+
repositories; setting up and using software environments;
183+
importing and running environments on EO Platforms;
184+
exporting environments (e.g. Docker, application package,
185+
openEO graph, etc) and sharing them; using Git, including
186+
provided by own organisation; managing versions of data, code
187+
and documentation; making projects/repositories citable;
188+
contributing to open source projects; publishing scientific
189+
results and other research outcomes on web, including scientific
190+
visualisations; discovering and exploring scientific results, data,
191+
code and documentation of other contributing researchers. -->
158192
---
159193

160194
<!-- HTML for actor cards Note: Maybe add some icons here for each of the roles -->

pages/Getting started with EarthCODE/Deep Dive into EarthCODE.md renamed to pages/Integrating New Platforms to EarthCODE/Deep Dive into EarthCODE.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,6 @@ order: 4
33
---
44
# Deep Dive into EarthCODE
55

6-
7-
# Hey There
8-
9-
10-
11-
:::tip This guide goes into detail about how EarthCODE works and how the different entities within it are related. For the purposes of browsing the catalog or publishing through any of the integrated platforms, you do not need to necesarily understand any of these details below. If however, you are publishing manually, are a platform provider trying to integrate, or otherwise interested in how EarthCODE works this guide will give you the necessary context and background.
12-
:::
13-
146
As described in [Step 1: Understand EarthCODE Terminology](/Getting%20started%20with%20EarthCODE/#step-1-understand-earthcode-terminology) EarthCODE provides an integrated ecosystem designed to support scientists through the full lifecycle of doing Open Science. EarthCODE was designed around supporting the work of scientists and developers from ESRIN, the ESA Science Clusters, the ESA Science Hub, and EC and ESA- Funded Activities.
157

168
A detailed concept of what EarthCODE is and the different actors involved can be seen in the figure below:
@@ -246,6 +238,18 @@ All platform providers are expected to integrate with EarthCODE's Single Sign-On
246238

247239
Integration with EarthCODE is supported by the **EOEPCA+ architecture**, which provides open-source building blocks and interface standards to ensure interoperability across platforms. This approach allows platforms to remain independent while contributing to a federated, reproducible, and scalable open science infrastructure.
248240

241+
<!-- The Interoperable Building Block Evolution Framework
242+
ensures continuity of the Common Architecture (EOEPCA) -
243+
which has defined a reference architecture for cloud EO
244+
platforms and has delivered a number of Building Blocks (BB)
245+
at different level of maturity and supporting community. They
246+
represent the state-of-the-art in terms of OGC standards.
247+
EOEPCA+ also ensures international engagement in
248+
interoperability, setting the framework for generic building
249+
block development. The Common Architecture Building Blocks
250+
provide interoperable open-source elements for the EarthCODE
251+
Architecture. -->
252+
249253
The EarthCODE project runs standard best practice procurement cycles on esa-star, platforms can apply during these tenders and propose to integrate into the EarthCODE ecosystem.
250254

251255
More information about how integrating with EarthCODE works, where and how to apply, can be found at the [Integrating New Platforms Page](../Integrating%20New%20Platforms%20to%20EarthCODE/).
@@ -338,6 +342,23 @@ Metadata describing datasets (Products) is published using the **SpatioTemporal
338342

339343
The catalog acts as both a registry of published research artifacts and an operational gateway for executing FAIR experiments across federated EO platforms. More information about the catalog and how it works can be found at [Data - Discovering Resources in The EarthCODE Catalog)](../Technical%20Documentation/Data/Discovering%20Resources%20in%20The%20EarthCODE%20Catalog)
340344

345+
<!-- One such component developed on top of EOEPCA open-
346+
source building blocks and which will be integrated in
347+
EarthCODE is the Open Science Catalogue (OSC).
348+
The Open Science Data Catalogue (ESA OSC, 2024) is an ESA
349+
Open Science activity aiming to enhance the discoverability and
350+
use of the various scientific and value-added results (i.e. data,
351+
code, documentation) achieved in Earth System Science
352+
research activities funded by ESA EO. The OSC provides open
353+
access for the scientific community to geoscience products
354+
(based on EO data from ESA and non-ESA missions and other
355+
geospatial information and models) across the whole spectrum
356+
of Earth Science domains. The OSC adheres to FAIR principles
357+
and promotes reproducibility of scientific studies. The OSC
358+
makes use of various Open-Source geospatial technologies such
359+
as pycsw, PySTAC, and OpenLayers and tries to contribute
360+
back to these projects in terms of software and standardisation
361+
(Schindler, 2023). -->
341362

342363
### How EarthCODE is FAIR
343364

0 commit comments

Comments
 (0)