You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/Integrating New Platforms to EarthCODE/User Documentation for Platforms Guide.md
+37-34Lines changed: 37 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,40 +32,10 @@ Make a pull merge request back to main
32
32
We will manually review and merge
33
33
34
34
35
-
# Format
36
-
Please follow the format guidelines below when creating EarthCODE platform documentation pages. Consistency across platform entries helps users easily compare capabilities and navigate the documentation site.
37
-
38
-
This does not aim to be an extensive documentation about your platform, just a summary of its key features and its integrations which EarthCODE users will use.
39
-
40
-
## Title and File name
41
-
Each platform documentation page must begin with a properly formatted title and use a consistent file naming convention:
42
-
- The Markdown file should be named after your platform, using **PascalCase with no spaces**.
43
-
Example: `EDC.md`, `DeepESDL.md`, `OpenEO.md`
44
-
- The first line of the document should be a `#` level heading with the **exact same name** as the file.
45
-
Example:
46
-
```markdown
47
-
# EDC
48
-
49
-
## About
50
-
Add your platform description inside the `<FeatureCard>` block provided in the template - this will render as a styled summary section at the top of your documentation page.
51
35
52
-
The **About** section should include a short overview of your platform, this can include:
53
-
- Who the platform is primarily designed for (e.g. scientists for polar science, EO data scientists, etc..)
54
-
- The types of science or domains it supports best (e.g. climate, land monitoring, atmospheric studies)
55
-
- What kind of workflows it enables (e.g. datacube analytics, ML inference, EO product generation)
DeepESDL is designed for interactive Earth System Data Lab exploration and analytics. It provides ready-to-use EO datacubes and powerful cloud-based tooling for data scientists and researchers. Ideal for climate, land, and atmosphere research, the platform supports datacube-driven workflows and reproducible experiment design.
63
-
</FeatureCard>
64
-
```
65
-
66
-
## Summary
36
+
## Platform Summary
67
37
68
-
This should be a summary of your platform’s capabilities. Be concise, accurate, and focus on how your platform supports FAIR, open, and reproducible science. These details feed both the platform’s page and the interactive platform explorer at the top of the [Platforms section](../Technical%20Documentation/Platforms/index.md)
38
+
This should be a summary of your platform’s capabilities. These details feed the interactive platform explorer at the top of the [Platforms section](../Technical%20Documentation/Platforms/index.md)
69
39
70
40
Add a JSON file for your platform in the repository at:
71
41
@@ -78,7 +48,7 @@ Required fields
78
48
-`href` (string): link to your platform documentation page, use an ext‑less path (e.g. `/Technical%20Documentation/Platforms/EDC/`).
79
49
-`datasets` (string[]): describe which datasets are available on your platform (e.g. `Sentinel-1`, `Landsat-8`, `MODIS`).
80
50
-`languages` (string[]): supported languages (e.g. `Python`, `R`, `JavaScript`).
- Use consistent names for datasets (e.g. `Sentinel-5P` not `S5P`)
107
77
- Check consistency with other json files.
108
78
79
+
80
+
# Format
81
+
Please follow the format guidelines below when creating EarthCODE platform documentation pages. Consistency across platform entries helps users easily compare capabilities and navigate the documentation site.
82
+
83
+
This does not aim to be an extensive documentation about your platform, just a summary of its key features and its integrations which EarthCODE users will use.
84
+
85
+
86
+
## Title and File name
87
+
Each platform documentation page must begin with a properly formatted title and use a consistent file naming convention:
88
+
- The Markdown file should be named after your platform, using **PascalCase with no spaces**.
89
+
Example: `EDC.md`, `DeepESDL.md`, `OpenEO.md`
90
+
- The first line of the document should be a `#` level heading with the **exact same name** as the file.
91
+
Example:
92
+
```markdown
93
+
# EDC
94
+
95
+
## About
96
+
Add your platform description inside the `<FeatureCard>` block provided in the template - this will render as a styled summary section at the top of your documentation page.
97
+
98
+
The **About** section should include a short overview of your platform, this can include:
99
+
- Who the platform is primarily designed for (e.g. scientists for polar science, EO data scientists, etc..)
100
+
- The types of science or domains it supports best (e.g. climate, land monitoring, atmospheric studies)
101
+
- What kind of workflows it enables (e.g. datacube analytics, ML inference, EO product generation)
DeepESDL is designed for interactive Earth System Data Lab exploration and analytics. It provides ready-to-use EO datacubes and powerful cloud-based tooling for data scientists and researchers. Ideal for climate, land, and atmosphere research, the platform supports datacube-driven workflows and reproducible experiment design.
109
+
</FeatureCard>
110
+
```
111
+
109
112
## Developing and Publishing Workflows & Data
110
113
111
114
In this section, explain how users create, manage, test and publish their workflows and data products using your platform, and how these integrate with EarthCODE.
Copy file name to clipboardExpand all lines: pages/Technical Documentation/Platforms/EDC/Pangeo.md
-16Lines changed: 0 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,22 +8,6 @@
8
8
On EarthCODE, Pangeo is provided through the **Euro Data Cube (EDC) EOxHub Workspace**. Pangeo offers a powerful, interactive environment for scalable geoscience, built on an open-source ecosystem of key Python tools including Jupyter, Xarray, Dask, STAC, and Zarr. It is designed for scientists to scale to massive, cloud-based Earth Observation datasets with little to no changes to your python workflows.
|[Pangeo](./Pangeo.md)| JupyterLab and Jupyter Notebooks are the primary interactive development environment. | Python with core libraries like Xarray, Dask, and NumPy. | In-notebook visualization using libraries like Matplotlib and the HoloViz suite (hvPlot, GeoViews). | Reproducible Jupyter Notebooks and containerized Python applications. |
26
-
27
11
## Developing and Publishing Workflows & Data
28
12
29
13
You develop workflows within the managed EDC EOxHub Workspace, an interactive JupyterLab environment. This setup allows you to use Dask Gateway to seamlessly scale your analysis from a single notebook to a powerful compute cluster.
0 commit comments