Skip to content

updating-guide-notebooks #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sunnydean merged 1 commit into from
Apr 16, 2026
Merged

updating-guide-notebooks #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples/contribute_via_osc_editor.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1982,7 +1982,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "default",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -1996,7 +1996,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.12"
"version": "3.13.11"
}
},
"nbformat": 4,
Expand Down
4 changes: 2 additions & 2 deletions examples/contribute_via_pr_osc.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2257,7 +2257,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "default",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -2271,7 +2271,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.14.2"
"version": "3.13.11"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion examples/earthcode_data_discovery.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8056,7 +8056,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "default",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand Down
220 changes: 114 additions & 106 deletions guide/0.Prerequisites-EarthCODE-Workspaces.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,109 +1,117 @@
{
"cells": [
{
"cell_type": "markdown",
"id": "fff64edd",
"metadata": {},
"source": [
"# 0.1 Prerequisites Using EarthCODE workspaces\n",
"\n",
"\n",
"\n",
"## Short introduction to Earthcode\n",
"At EarthCODE we aim to not just store data but make it easily accessible and [FAIR](https://esa-earthcode.github.io/documentation/Community%20and%20Best%20Practices/FAIR%20and%20Open%20Science%20Best%20Practices/). The Open Science Catalog is built on the [Spatio Temporal Asset Catalog (STAC)](https://stacspec.org/en), which is a standard for describing geospatial data. Therefore new entries must conform to its specification.\n",
"\n",
"To process your data and publish it on Open Science Data Catalogue, we need six things from you to get started:\n",
"\n",
"1. Information about your ESA (EO Programme) funded `Project`, \n",
"2. Information about your `Product / Dataset`\n",
"3. Information about the actual `files/data`\n",
"4. Whether you need to `store your results permanently on ESA cloud storage`.\n",
"5. Information about the `workflow/code` you used to generate the data.\n",
"6. Information about the `experiment` that generated the dataset.\n",
"\n",
"We've broken the process into five steps, contained within five notebooks. You can run the individual notebooks and commit the results via pull request to the open science catalog libray. Below you can find instructions how to do this via the EarthCODE workspace.\n",
"\n",
"## Intro to Earthcode workspaces:\n",
"\n",
"\n",
"The [EarthCODE workspace](https://workspace.earthcode.eox.at) allows you to access to an integrated Jupyter Lab environment with the EarthCODE library installed, in order for you to quickly get started with scientific research and experiments.\n",
"\n",
"The login, you must have a [GitHub account](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github).\n",
"\n",
"Once you are logged in, you can access all features directly through the portal or find links to them.\n",
"\n",
"When you log in, you will find the navigation bar on the left-hand side, containing links to all available resources and tasks, while the middle pane serves as the main interactive area, changing depending on the option you select.\n",
"\n",
"\n",
"## 1. Create a copy of Open Science Catalog metadata\n",
"\n",
"You can add new content to the OSC via GitHub [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). To do this, you need a to [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) the OSC repository, embeded the new information into the existing catalog and merge. The steps below describe the process.\n",
"\n",
"1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the open science catalog repository on github - [https://github.com/ESA-EarthCODE/open-science-catalog-metadata](https://github.com/ESA-EarthCODE/open-science-catalog-metadata)\n",
"\n",
"2. Then clone your forked repository and create a branch by using the Git GUI available in the EarthCODE Workspaces:\n",
"\n",
"![image.png](../assets/clone-and-branch.gif)\n",
"\n",
"\n",
"## 2. Sequence of actions\n",
"\n",
"First clone the earthcode library guide notebooks by running inside your accounts workspace:\n",
"`git clone https://github.com/ESA-EarthCODE/earthcode-library.git`\n",
"\n",
"Run notebooks in this order:\n",
"1. `guide/1.Project.ipynb`\n",
"2. `guide/2.Product.ipynb`\n",
"3. Either `guide/2.1.Product_files_PRR.ipynb` or `guide/2.2.Product.ipynb`, depending on the results from step 2.\n",
"4. `guide/3.Workflow.ipynb`\n",
"5. `guide/4.Experiment.ipynb`\n",
"6. Open a pull request against the main OSC repository\n",
"\n",
"\n",
"## 3. Opening a GitHub PR\n",
"\n",
"After the validation passes, you are ready to request changes into existing [open-science-catalog-metadata](https://github.com/ESA-EarthCODE/open-science-catalog-metadata) repository to be able to publish your datasets and project by using the EarthCODE Workspaces Git GUI as shown below.\n",
"\n",
"1. First you need to create a valid token.\n",
" 1. go to https://github.com/settings/personal-access-tokens\n",
" 2. click on fine-grained tokens, and select generate new token\n",
" 3. Limit access to the forked repository and provide read-write Contents permissions\n",
" 4. Copy the token produced\n",
"\n",
"![createtoken](../assets/create-token.gif)\n",
"\n",
"1. Commit changes using the EarthCODE Workspaces Git GUI (or terminal commands)\n",
"\n",
"![commitclip.gif](../assets/commitclip.gif)\n",
"\n",
"3. Open a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) against the main open science catalog repository<br>\n",
" `gh pr create -f`\n",
"\n",
"Or alternatively directly via github.com:\n",
"![pullrequest.gif](../assets/pullrequest.gif)\n",
"\n",
"\n",
"### Check the status of your PR direclty in GitHub\n",
"\n",
"After creation of Pull Request you should see it on the list: https://github.com/ESA-EarthCODE/open-science-catalog-metadata/pulls\n",
"\n",
"Check the status of your PR under: https://github.com/ESA-EarthCODE/open-science-catalog-metadata/actions\n",
"\n",
"> Changes to the OSC content will be reviewed by the EarthCODE Data Steward team. In case any changes are needed to your inputs, you will be contacted by the team."
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"name": "python",
"version": "3"
}
"cells": [
{
"cell_type": "markdown",
"id": "fff64edd",
"metadata": {},
"source": [
"# 0.1 Prerequisites Using EarthCODE workspaces\n",
"\n",
"\n",
"\n",
"## Short introduction to Earthcode\n",
"At EarthCODE we aim to not just store data but make it easily accessible and [FAIR](https://esa-earthcode.github.io/documentation/Community%20and%20Best%20Practices/FAIR%20and%20Open%20Science%20Best%20Practices/). The Open Science Catalog is built on the [Spatio Temporal Asset Catalog (STAC)](https://stacspec.org/en), which is a standard for describing geospatial data. Therefore new entries must conform to its specification.\n",
"\n",
"To process your data and publish it on Open Science Data Catalogue, we need six things from you to get started:\n",
"\n",
"1. Information about your ESA (EO Programme) funded `Project`, \n",
"2. Information about your `Product / Dataset`\n",
"3. Information about the actual `files/data`\n",
"4. Whether you need to `store your results permanently on ESA cloud storage`.\n",
"5. Information about the `workflow/code` you used to generate the data.\n",
"6. Information about the `experiment` that generated the dataset.\n",
"\n",
"We've broken the process into five steps, contained within five notebooks. You can run the individual notebooks and commit the results via pull request to the open science catalog libray. Below you can find instructions how to do this via the EarthCODE workspace.\n",
"\n",
"## Intro to Earthcode workspaces:\n",
"\n",
"\n",
"The [EarthCODE workspace](https://workspace.earthcode.eox.at) allows you to access to an integrated Jupyter Lab environment with the EarthCODE library installed, in order for you to quickly get started with scientific research and experiments.\n",
"\n",
"The login, you must have a [GitHub account](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github).\n",
"\n",
"Once you are logged in, you can access all features directly through the portal or find links to them.\n",
"\n",
"When you log in, you will find the navigation bar on the left-hand side, containing links to all available resources and tasks, while the middle pane serves as the main interactive area, changing depending on the option you select.\n",
"\n",
"\n",
"## 1. Create a copy of Open Science Catalog metadata\n",
"\n",
"You can add new content to the OSC via GitHub [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). To do this, you need a to [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) the OSC repository, embeded the new information into the existing catalog and merge. The steps below describe the process.\n",
"\n",
"1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the open science catalog repository on github - [https://github.com/ESA-EarthCODE/open-science-catalog-metadata](https://github.com/ESA-EarthCODE/open-science-catalog-metadata)\n",
"\n",
"2. Then clone your forked repository and create a branch by using the Git GUI available in the EarthCODE Workspaces:\n",
"\n",
"![image.png](../assets/clone-and-branch.gif)\n",
"\n",
"\n",
"## 2. Sequence of actions\n",
"\n",
"First clone the earthcode library guide notebooks by running inside your accounts workspace:\n",
"`git clone https://github.com/ESA-EarthCODE/earthcode-library.git`\n",
"\n",
"Run notebooks in this order:\n",
"1. `guide/1.Project.ipynb`\n",
"2. `guide/2.Product.ipynb`\n",
"3. Either `guide/2.1.Product_files_PRR.ipynb` or `guide/2.2.Product.ipynb`, depending on the results from step 2.\n",
"4. `guide/3.Workflow.ipynb`\n",
"5. `guide/4.Experiment.ipynb`\n",
"6. Open a pull request against the main OSC repository\n",
"\n",
"\n",
"## 3. Opening a GitHub PR\n",
"\n",
"After the validation passes, you are ready to request changes into existing [open-science-catalog-metadata](https://github.com/ESA-EarthCODE/open-science-catalog-metadata) repository to be able to publish your datasets and project by using the EarthCODE Workspaces Git GUI as shown below.\n",
"\n",
"1. First you need to create a valid token.\n",
" 1. go to https://github.com/settings/personal-access-tokens\n",
" 2. click on fine-grained tokens, and select generate new token\n",
" 3. Limit access to the forked repository and provide read-write Contents permissions\n",
" 4. Copy the token produced\n",
"\n",
"![createtoken](../assets/create-token.gif)\n",
"\n",
"1. Commit changes using the EarthCODE Workspaces Git GUI (or terminal commands)\n",
"\n",
"![commitclip.gif](../assets/commitclip.gif)\n",
"\n",
"3. Open a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) against the main open science catalog repository<br>\n",
" `gh pr create -f`\n",
"\n",
"Or alternatively directly via github.com:\n",
"![pullrequest.gif](../assets/pullrequest.gif)\n",
"\n",
"\n",
"### Check the status of your PR direclty in GitHub\n",
"\n",
"After creation of Pull Request you should see it on the list: https://github.com/ESA-EarthCODE/open-science-catalog-metadata/pulls\n",
"\n",
"Check the status of your PR under: https://github.com/ESA-EarthCODE/open-science-catalog-metadata/actions\n",
"\n",
"> Changes to the OSC content will be reviewed by the EarthCODE Data Steward team. In case any changes are needed to your inputs, you will be contacted by the team."
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"nbformat": 4,
"nbformat_minor": 5
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.13.11"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
Loading
Loading