Skip to content

Commit cc0eccd

Browse files
authored
Merge pull request #67 from ESA-EarthCODE/rebase-review2
Review Edits from table 2
2 parents 9328a98 + 475c81b commit cc0eccd

File tree

134 files changed

+1462
-271
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

134 files changed

+1462
-271
lines changed

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,11 @@ node_modules
22
.vitepress/dist
33
.vitepress/cache
44
examples/_build
5+
.DS_Store
6+
pages/.DS_Store
7+
pages/Community and Collaboration/.DS_Store
8+
pages/Community and Collaboration/Getting Started With The EarthCODE Discourse/.DS_Store
9+
pages/Integrating New Platforms to EarthCODE/.DS_Store
10+
pages/public/img/.DS_Store
11+
pages/public/img/platforms/.DS_Store
12+
pages/public/img/terms/.DS_Store

.vitepress/config.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ const sideBar = withSidebar(
88
cleanUrls: true,
99
title: "EarthCODE Documentation",
1010
titleTemplate: " EarthCODE",
11+
collapsed: true,
1112
description: "Documentation for the EarthCODE website",
1213
base: "/documentation/documentation/",
1314
ignoreDeadLinks: [
@@ -111,6 +112,10 @@ const sideBar = withSidebar(
111112
const trainingSection = sideBar.themeConfig.sidebar.find(section => section.text === 'Training and Resources')
112113
trainingSection.items.push({ text: 'Examples', link: 'https://esa-earthcode.github.io/documentation/examples/' })
113114

115+
sideBar.themeConfig.sidebar.forEach(group => {
116+
group.collapsed = true;
117+
});
118+
114119
export default defineConfig(
115120
sideBar
116121
);
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<template>
2+
<div class="feature-card">
3+
<div class="text"><slot /></div>
4+
<div class="image">
5+
<img :src="resolvedSrc" :alt="alt" />
6+
</div>
7+
</div>
8+
</template>
9+
10+
<script setup>
11+
// resolve relative image paths to work with Vite's base URL
12+
import { computed } from 'vue'
13+
const props = defineProps({
14+
img: { type: String, required: true },
15+
alt: { type: String, default: '' }
16+
})
17+
const base = import.meta.env.BASE_URL
18+
const resolvedSrc = computed(() => {
19+
if (props.img.startsWith('/')) {
20+
return base + props.img.slice(1)
21+
}
22+
return props.img
23+
})
24+
</script>
25+
26+
<style>
27+
.feature-card {
28+
display: flex;
29+
align-items: center;
30+
gap: 1rem;
31+
margin: 1.5rem 0;
32+
}
33+
.feature-card .text {
34+
flex: 1;
35+
padding-right: 1rem;
36+
}
37+
.feature-card .image img {
38+
max-width: 250px;
39+
height: auto;
40+
border-radius: 4px;
41+
}
42+
</style>
43+

.vitepress/theme/index.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
import Layout from "./Layout.vue";
22
import "./style.css";
3+
import FeatureCard from './components/FeatureCard.vue'
4+
35

46
/** @type {import('vitepress').Theme} */
57
export default {
@@ -9,5 +11,6 @@ export default {
911
app.use(await import("@eox/esa-ui/components/header.js"));
1012
app.use(await import("@eox/esa-ui/components/cookies.js"));
1113
}
14+
app.component('FeatureCard', FeatureCard)
1215
}
1316
};

pages/Community and Best Practices/Code Data and Workflow Quality.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1+
---
2+
order: 2
3+
---
14
# Code, Data and Workflow Quality
2-
5+
:::warning 🛠️ Page Under Development
6+
Content is being actively developed and updated for this page. EarthCODE's documentation is a living document and will be continuously updated with detailed reviews.
7+
:::
38
## Applying and maintaining FAIR Principles
49

510
The checklist below provides practical guidance for applying the FAIR principles in EarthCODE projects.

pages/Community and Best Practices/FAIR and Open Science.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
1+
---
2+
order: 1
3+
---
14
# FAIR and Open Science
25

6+
## Why FAIR?
7+
8+
Modern Earth system science faces complex challenges that demand collaborative, transparent, and reproducible approaches. At the heart of this transformation is the convergence of **FAIR principles** (Findability, Accessibility, Interoperability, and Reusability) and Open Science - which create unprecedented opportunities for scalable, cross-sector research and decision-making.
9+
10+
ESA's strategic objective is to **foster the development of a culture and practice of openness in EO science, applications and industry, and of a sustainable open innovation ecosystem**.
11+
12+
![Open Science](/img/terms/open-science-esa.png)
13+
14+
Adopting FAIR principles at scale for data and workflows in Earth Observation is essential for implementing this vision as it enables scientists to (1) Access and process satellite and in-situ data (in collaborative cloud environments such as EarthCODE Platforms), (2) Develop and publish reusable code and workflows, (3) Validate outputs and share reproducible results, and (4) Collaborate across institutional, disciplinary, and national boundaries. Openness enhances transparency and trust in research results, facilitates collaboration between different institutions and disciplines, and significantly reduces duplication of efforts.
15+
16+
Moreover, FAIR and Open Science practices improve data quality and longevity, allowing researchers to build upon existing knowledge and to more effectively address complex global challenges such as climate change, biodiversity loss, and sustainable development.
17+
18+
Adopting FAIR and Open Science practices also provides direct personal benefits to researchers. It enhances the visibility and citation of their work, fosters potential new collaborations, and expands professional networks. Moreover, by making research outputs clearly documented and easily accessible, researchers save time in their daily workflows, simplify data management tasks, and improve their ability to build upon prior work—including their own.
19+
320
## Open Science: A Collaborative and Transparent Approach
421
Open Science is a movement that promotes transparency, accessibility, and collaboration in scientific research. According to [UNESCO Recommendation on Open Science](https://www.unesco.org/en/open-science/about?hub=686), Open Science encompasses open access to scientific knowledge, open data, open-source software, open workflows and broader participation in research processes.
522

@@ -27,7 +44,7 @@ FAIR is not just about data; **software**, **models**, and **workflows** must al
2744
- **FAIR metadata** for software and workflows, ensuring clear documentation of inputs, outputs, dependencies, and provenance.
2845
- **Persistent identifiers (PIDs)** for datasets, algorithms, and workflows to support traceability and reuse.
2946
- **Interoperable formats and standards**, such as netCDF, Zarr, and STAC for data, or CWL (Common Workflow Language) for workflow portability, OGC API - Processes for standardized execution, and openEO for cloud-based EO data processing, ensuring compatibility across platforms.
30-
- **Accessible computing environments**, such as the [cloud-based processing platforms available in EarthCODE](https://esa-earthcode.github.io/documentation/Technical%20Documentation/Working%20With%20Platforms%20and%20Sponsorship/), which allow users to execute EO workflows.
47+
- **Accessible computing environments**, such as the [cloud-based processing platforms available in EarthCODE](https://nor-discover.org/), which allow users to execute EO workflows.
3148

3249
**FAIR does not imply that data or software must be open** by default, but rather that they are well-described, structured, and reusable under appropriate conditions. By applying FAIR principles to both data and processing, the EO community can enhance scientific transparency, improve cross-disciplinary collaboration, and enable scalable, automated analysis—key for addressing global challenges like climate change, disaster response, and biodiversity conservation.
3350

@@ -77,9 +94,29 @@ The FAIR principles provide high-level guidance for ensuring that data, software
7794
By explicitly declaring its choices, the EarthCODE community ensures that its approach to FAIR is transparent, actionable, and aligned with best practices in Earth Observation data management and processing.
7895
This structured implementation enhances data discoverability, interoperability, and reuse while maintaining technical rigor and community consensus.
7996

97+
## Open Science: A Collaborative and Transparent Approach
98+
Open Science is a movement that promotes transparency, accessibility, and collaboration in scientific research. According to [UNESCO Recommendation on Open Science](https://www.unesco.org/en/open-science/about?hub=686), Open Science encompasses open access to scientific knowledge, open data, open-source software, open workflows and broader participation in research processes.
99+
100+
## Collaboration Tips
101+
A fundamental aspect of Open Science is **sharing while doing**, rather than treating data and publications as an afterthought. The earlier Open Science principles are incorporated into research workflows, the easier they are to implement. This approach enables:
102+
103+
- **Early data sharing**, fostering collaboration and enabling reproducibility.
104+
- **Transparent methodologies**, making research processes more robust and verifiable.
105+
- **Open access to publications and resources**, ensuring that knowledge is freely available to the broader community.
106+
107+
By integrating Open Science with FAIR principles, the EO community can maximize the impact of research, enhance data accessibility, and facilitate cross-domain innovation.
108+
109+
110+
111+
### Collaboration in EarthCODE
112+
113+
Guidance for setting up user permissions, managing team workflows, and collaborating with other researchers within the EarthCODE environment.
114+
115+
80116
### References
81117

82-
- Wilkinson, M., Dumontier, M., Aalbersberg, I. et al. The FAIR Guiding Principles for scientific data management and stewardship. Sci Data 3, 160018 (2016). [DOI: 10.1038/sdata.2016.18](https://doi.org/10.1038/sdata.2016.18)
83-
- FAIR Data Maturity Model Working Group. (2020). FAIR Data Maturity Model. Specification and Guidelines (1.0). Zenodo. [DOI: 10.15497/rda00050](https://doi.org/10.15497/rda00050)
84-
- Annika Jacobsen, Ricardo de Miranda Azevedo, Nick Juty, Dominique Batista, Simon Coles, Ronald Cornet, Mélanie Courtot, Mercè Crosas, Michel Dumontier, Chris T. Evelo, Carole Goble, Giancarlo Guizzardi, Karsten Kryger Hansen, Ali Hasnain, Kristina Hettne, Jaap Heringa, Rob W.W. Hooft, Melanie Imming, Keith G. Jeffery, Rajaram Kaliyaperumal, Martijn G. Kersloot, Christine R. Kirkpatrick, Tobias Kuhn, Ignasi Labastida, Barbara Magagna, Peter McQuilton, Natalie Meyers, Annalisa Montesanti, Mirjam van Reisen, Philippe Rocca-Serra, Robert Pergl, Susanna-Assunta Sansone, Luiz Olavo Bonino da Silva Santos, Juliane Schneider, George Strawn, Mark Thompson, Andra Waagmeester, Tobias Weigel, Mark D. Wilkinson, Egon L. Willighagen, Peter Wittenburg, Marco Roos, Barend Mons, Erik Schultes; FAIR Principles: Interpretations and Implementation Considerations. Data Intelligence 2020; 2 (1-2): 10–29. [DOI: 10.1162/dint_r_00024](https://doi.org/10.1162/dint_r_00024)
118+
*- Wilkinson, M., Dumontier, M., Aalbersberg, I. et al. (2016). The FAIR Guiding Principles for scientific data management and stewardship. *Scientific Data*, 3, Article 160018. [https://doi.org/10.1038/sdata.2016.18](https://doi.org/10.1038/sdata.2016.18)*
119+
120+
*- FAIR Data Maturity Model Working Group. (2020). FAIR Data Maturity Model: Specification and Guidelines (Version 1.0). *Zenodo*. [https://doi.org/10.15497/rda00050](https://doi.org/10.15497/rda00050)*
85121

122+
*- Jacobsen, A., de Miranda Azevedo, R., Juty, N., Batista, D., Coles, S., Cornet, R., Courtot, M., Crosas, M., Dumontier, M., Evelo, C. T., Goble, C., Guizzardi, G., Hansen, K. K., Hasnain, A., Hettne, K., Heringa, J., Hooft, R. W. W., Imming, M., Jeffery, K. G., Kaliyaperumal, R., Kersloot, M. G., Kirkpatrick, C. R., Kuhn, T., Labastida, I., Magagna, B., McQuilton, P., Meyers, N., Montesanti, A., van Reisen, M., Rocca-Serra, P., Pergl, R., Sansone, S.-A., da Silva Santos, L. O. B., Schneider, J., Strawn, G., Thompson, M., Waagmeester, A., Weigel, T., Wilkinson, M. D., Willighagen, E. L., Wittenburg, P., Roos, M., Mons, B., & Schultes, E. (2020). FAIR Principles: Interpretations and Implementation Considerations. *Data Intelligence*, 2(1–2), 10–29. [https://doi.org/10.1162/dint_r_00024](https://doi.org/10.1162/dint_r_00024)*

pages/Community and Best Practices/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,11 @@ order: 4
33
---
44
# Best practices
55

6-
- [Code, Data and Workflow Quality](./Code%20Data%20and%20Workflow%20Quality.md)
7-
- [FAIR and Open Science](./FAIR%20and%20Open%20Science.md)
6+
The EarthCODE ecosystem is designed to support FAIR and Open Science by default—but achieving that in practice depends on how you prepare and publish and manage your code, data, and workflows. This section introduces how EarthCODE implements FAIR principles and resources to help you follow best practices that make your research more findable, accessible, interoperable, and reusable.
7+
8+
These guides show you how to structure your work in a way that's aligned with EarthCODE requirements and community standards. You’ll find practical advice on how to improve metadata, adopt version control, structure your documentation, and ensure that your outputs are truly FAIR.
9+
10+
Explore the following guides:
11+
12+
- [Code, Data and Workflow Quality](./Code%20Data%20and%20Workflow%20Quality.md): A practical walkthrough for preparing your research artefacts for publication and reuse.
13+
- [FAIR and Open Science](./FAIR%20and%20Open%20Science.md): An in-depth look at how to make your published results FAIR and how EarthCODE supports you in that journey.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
order: 0
3+
---
4+
# Collaborating Within a Project
5+
:::warning 🛠️ Page Under Development
6+
Content is being actively developed and updated for this page. EarthCODE's documentation is a living document and will be continuously updated with detailed reviews.
7+
:::
8+
How to collaborate with other researchers within EarthCODE.
9+

pages/Community and Collaboration/Collaboration and Community/Joining or Creating a Research Team.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

pages/Community and Collaboration/Collaboration and Community/Sharing and Publishing Results.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,8 @@
22
order: 2
33
---
44
# Sharing and Publishing Results
5+
:::warning 🛠️ Page Under Development
6+
Content is being actively developed and updated for this page. EarthCODE's documentation is a living document and will be continuously updated with detailed reviews.
7+
:::
58
Instructions on how to share research outputs, including data, code, and documentation, and manage their publication through the Open Science Catalog.
69

0 commit comments

Comments
 (0)