🛠️ Page Under Development
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.
Guidance on how to integrate external cloud computing services and other relevant platforms to EarthCODE.
You need to maintain your own documentation and provide documentation about your EarthCODE integration, to this portal.
Note that technical documentation about the inner workings of your platform and it's integration with EarthCODE is separate from this. This is the user-facing documentation for your platform on EarthCODE.
Clone this repo Create a new branch Make a new .md file under pages/Technical Documentation/Platforms/your-platform.md (vitepress workflow explain it in a nutshell) Copy the template given bellow and fill it out. Guidance is provided below. Remove sections that are not relevant. Try to run npm dev build to make sure it builds Make a pull merge request back to main We will manually review and merge
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.
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.
Each platform documentation page must begin with a properly formatted title and use a consistent file naming convention:
EDC.md, DeepESDL.md, OpenEO.md# level heading with the exact same name as the file.# EDCAdd 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.
The About section should include a short overview of your platform, this can include:
Upload your logo to the following path:/public/img/platforms/platform_logos/your-platform-name.png
<FeatureCard img="/img/platforms/platform_logos/deepesdl.webp" alt="DeepESDL Logo">
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.
</FeatureCard>This should be a summary table of your platforms' capabilites. This helps other users and project partners understand what your platform offers. Entries should be concise, accurate, and written in the context of how your platform supports FAIR, open, and reproducible science. The tables will be directly copied in the Platforms Page of the documentation.
| Field | Description and Guidance |
|---|---|
| Platform | Provide the name of your platform and a link to your EarthCODE documentation page hosted on this site. |
| Data Access | Describe which datasets are available on your platform. Include key EO missions (e.g. Sentinel-1, MODIS, Landsat), thematic focus areas, and whether access is via APIs, STAC, OGC endpoints, or catalog services. |
| Specialised Hardware & Services | Summarise what compute infrastructure is available. This could include for example aspects like access to GPUs, TPUs, Machine Learning Services (e.g. Seldon Core for inference, MLflow), support for scalable frameworks like Dask, batch processing, orchestration services, or anything that enables high-performance data processing. |
| Compatible Workflows | Indicate the types of workflows your platform supports execution of. For example, OGC API Processes, OpenEO Process Graphs, MLflow pipelines, or Application Packages. |
| Field | Description and Guidance |
|---|---|
| Platform | Provide the name of your platform and a link to your EarthCODE documentation page hosted on this site. |
| Development Tools | Describe the tools available for scientists to build, test, and run experiments. This could include Jupyter, GUI-based editors, sepcialised SDKs/APIs, or custom development environments. |
| Supported Languages | List the programming languages and frameworks supported by your platform (e.g. Python, R, JavaScript). |
| Visualization Tools | Summarise built-in tools that allow users to visualise data. This may include datacube viewers, dashboard interfaces, time-series plots, maps, or support for WMS/WMTS. |
| Produced Workflow Type | Describe the format or interface of the workflows produced by your platform. For example, OGC API Processes, OpenEO Process Graphs, or other reusable, workflows. |
When filling out your entry, focus on what users can do with your platform in the context of EarthCODE. Avoid overly general descriptions—aim for clarity, specificity, and practical insight into your platform’s capabilities. We would advise filling this table last and summarizing from the other sections.
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.
Generally try and provide visual aids to help users follow along:
You can upload your assets under a folder for your platform, e.g.: /pages/public/img/platforms/platform_materials/yourplatformname/
and reference them in Markdown like so:
Learn By Example Provide an example notebook/code in the Examples section of this guide through this repository: https://github.com/ESA-EarthCODE/examples
Developing Workflows
First describe your platform’s dev environment. Include details such as:
Link to your example/examples in this section.
Publishing to EarthCODE
Explain how your platform publishes data and workflows to EarthCODE, include details such as:
In this section, explain which datasets your platform makes available and how users can retrieve them. Describe the range of Earth Observation collections (for example Sentinel‑1, Landsat, MODIS) as well as any domain‑specific or value‑added archives. Indicate whether data is available in cloud‑optimised formats such as Cloud‑Optimized GeoTIFF (COG) or Zarr, and whether spatial or temporal subsetting is supported.
Provide details on how to access the data — this might include STAC API endpoints or direct object‑storage URLs. If you offer SDKs or CLI tools, show a brief example.
Include links to documentation pages where the users can further explore data access and these endpoints.
Describe any specialised hardware or additional PaaS (platform as a service) features your platform provides. For example this could be GPU or TPU availability, support for parallel frameworks like Dask or Spark, and any machine learning services you provide (for example Seldon Core for inference or MLflow for training).
You can include examples of how these resources are created or used in your platform, e.g:
from dask_gateway import Gateway
gateway = Gateway()
cluster = gateway.new_cluster(worker_cores=4, worker_memory="16GiB", worker_gpu=1)
client = cluster.get_client()Include links to documentation pages where the users can further explore the specialised hardware & services you offer.
Describe the built‑in capabilities and integrations your platform provides for exploring and visualizing data. You might include:
Include links to documentation pages where the users can further explore the visualization tools you offer.
Summarize how users obtain and configure your service, including the available “sizes” or tiers (e.g. small/medium/large, CPU/Mem resources, etc..). This could just be a brief summary of what you have on the Network on Resources.
If possible, offer rough guidance on what resources users might need to apply for in common scenarios for your platform.
Include a link to the NoR page of your platform at the end of this section.
Provide a list of currated tutorials for anyone interested in learning about your platform.
Describe where users can get support for the platform (technical issues and/or general querries) - provide links to support forms, emails or other website links.
If you have a community forum, please share a link here and provide a summary of it.
Finally, provide a link to your comprehensive documentation, API reference, tutorials and the page where users can find more about your platform offering.
# Platform Name
*example-platform-website.com*
## About
<FeatureCard img="/img/EarthCODE_kv_transparent.png" alt="Platform Logo">
Lorem ipsum description of a platform
- **Analyze events or phenomena** from multiple perspectives
- Access **multiple data sources** and compare or correlate variables simultaneously
- **Customize your data pipeline** to suit specific needs
- **Try it out for free** and kick‑start your Earth Observation application!
</FeatureCard>
## Summary
**Infrastructure Capabilities**
| Platform | Data Access | Specialised Hardware & Services | Compatible Workflows |
|--------------------------------------|----------------------------------------------------------------------------------------------------------|----------------------------------|---------------------------|
**FAIR Open Science Development Capabilities**
| Platform | Development Tools | Supported Languages | Visualization Tools | Produced Workflow Type |
|--------------------------------------|----------------------------------------|------------------------------|--------------------------------------------------|----------------------------|
### Developing Workflows
**Learn By Example**
**Developing Workflows**
**Publishing to EarthCODE**
### Data Access
### Specialised Hardware & Services
### Visualization Tools
## Right Sizing and Network of Resources
*link-to-NoR-page*
## Tutorials
## Support and Communities
## Full Documentation Can be Found At
*example-platform-website.com/documentation*For review reference this should render as below: markdown
example-platform-website.com
Infrastructure Capabilities
| Platform | Data Access | Specialised Hardware & Services | Compatible Workflows |
|---|
FAIR Open Science Development Capabilities
| Platform | Development Tools | Supported Languages | Visualization Tools | Produced Workflow Type |
|---|
Developing Workflows
Publishing to EarthCODE
link-to-NoR-page
example-platform-website.com/documentation