Skip to content

Commit 9f344e1

Browse files
committed
updated docs
1 parent 40252c8 commit 9f344e1

2 files changed

Lines changed: 1 addition & 10 deletions

File tree

docs/getting-started.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
# Getting Started
22

3-
When working with cloud platforms like DeepESDL, workflow outputs typically live in S3 object storage. Before the project ends or once datasets and workflows are finalized, move the datasets into the ESA Project Results Repository (PRR) and publish the workflows (Jupyter notebooks) to a publicly accessible GitHub repository. The notebook path becomes an input in the dataset config file.
4-
5-
Use the EarthCODE Project Results Repository to publish and preserve outputs from ESA-funded Earth observation projects. It is professionally maintained, FAIR-aligned, and keeps your results findable, reusable, and citable for the long term—no storage, operations, or access headaches.
6-
7-
To transfer datasets into the ESA PRR, contact the DeepESDL platform team at [esdl-support@brockmann-consult.de](mailto:esdl-support@brockmann-consult.de).
8-
9-
In the near future, `deep-code` will include built-in support for uploading your results to the ESA PRR as part of the publishing workflow, making it seamless to share your scientific contributions with the community.
10-
113
## Requirements
124
- Python 3.10+
135
- GitHub token with access to the target EarthCODE metadata repo.
@@ -39,5 +31,3 @@ The CLI or the Python API reads GitHub credentials from a `.gitaccess` file in t
3931
github-token: your-personal-access-token
4032
```
4133
Replace your-git-user and your-personal-access-token with your actual GitHub username and token.
42-
43-

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- Generate starter dataset and workflow YAML templates.
77
- Publish dataset collections, workflows, and experiments via a single command.
88
- Build STAC collections and catalogs for Datasets and their corresponding variables automatically from the dataset metadata.
9+
- Generate STAC catalog and item for the product (Zarr store) and publish them to S3.
910
- Build OGC API records for Workflows and Experiments from your configs.
1011
- Flexible publishling targets i.e production/staging/testing EarthCODE metadata repositories with GitHub automation.
1112

0 commit comments

Comments
 (0)