Add section on Publishing to the OSC ("step 3") #71
Conversation
anders0204
commented
May 2, 2025
anders0204
commented
- Added a description on how to upload the product to the OSC. A simple description, but also a simple process. It's intentional to make this step less confusing.
- Commented out what was there previously. There are some good information here, but most of it is already mentioned at the start of the page.
- Should I delete this?
|
Schpidi
left a comment
Schpidi
left a comment
There was a problem hiding this comment.
Thanks for expanding the documentation. I've left a view suggestions.
|
|
||
| After completing steps 1 and 2 to prepare your data package, you're now ready to add a product entry to the Open Science Catalog (OSC). | ||
|
|
||
| This involves creating a new collection folder under the `products` directory in the [`open-science-catalog-metadata-staging`](https://github.com/ESA-EarthCODE/open-science-catalog-metadata-staging) repository. The process is straightforward, especially if you're already familiar with Git. |
There was a problem hiding this comment.
The URL should point the production OSC at https://github.com/ESA-EarthCODE/open-science-catalog-metadata
|
|
||
| Refer to the diagram below for a detailed overview of the required fields for OSC products: | ||
|
|
||
|  |
There was a problem hiding this comment.
Maybe add a diagram showing the OSC structure along the lines of this:
|
|
||
| ## Step 3: Creating a Product Entry in the Open Science Catalog | ||
|
|
||
| After completing steps 1 and 2 to prepare your data package, you're now ready to add a product entry to the Open Science Catalog (OSC). |
There was a problem hiding this comment.
I propose to extend this paragraph with: "This can be done by using the Catalog Editor in the EarthCODE portal or by using Git directly as described below."
|
|
||
| Here’s the general workflow: | ||
|
|
||
| 1. Fork the [`open-science-catalog-metadata-staging`](https://github.com/ESA-EarthCODE/open-science-catalog-metadata-staging) repository to your own GitHub account. |
There was a problem hiding this comment.
| ::: tip | ||
| If you're not confident using Git or find the process cumbersome, tools are being developed to simplify it! | ||
|
|
||
| Check out the GUI-based [Git Clerk](https://dashboard.earthcode-staging.earthcode.eox.at/osc-editor) or the CLI-based [deep-code](https://github.com/deepesdl/deep-code) for a smoother experience. |
There was a problem hiding this comment.
I suppose we should rather link to the pages describing this apps in this documentation.
| --- | ||
|
|
||
| # Publishing Science Results | ||
|
|
There was a problem hiding this comment.
I see that in the issue:#42 the first sentence is marked as updated, but I do not see these updates here..
Please update the text to following: "The ESA Open Science Data Catalogue provides free and open access to geoscience products for any user, without the need for authorization. By promoting FAIR and Open Science principles, this catalogue invites contributions from authorized users, enriching the scientific community with a diverse array of geospatial products. Contributions from users willing to share scientific outcomes and experiments help foster collaboration, innovation, and the continuous growth of scientific knowledge".
|
|
||
| ## Who can contribute? | ||
|
|
||
| Contributions to the Open Science Data Catalogue are vital for advancing FAIR Open Science Principles across ESA-funded Earth Science activities. |
There was a problem hiding this comment.
Contribution to the ESA Open Science Data Catalogue
|
|
||
| Contributions to the Open Science Data Catalogue are vital for advancing FAIR Open Science Principles across ESA-funded Earth Science activities. | ||
| We would like to specifically encourage contributions from: | ||
|
|
There was a problem hiding this comment.
to add also ESA Project and activities (as we have some EO activities which are not considered as a project but rather specific activity to produce certain level of datasets from EO products (example S3 AMPLI dataset)
| Make sure the Catalog uses **relative paths** and points to remote asset URLs! | ||
| ::: | ||
|
|
||
| 3. **Describe Your Research in the Open Science Catalog** |
There was a problem hiding this comment.
Describe your Research Experiments in the ESA Open Science Catalogue
There was a problem hiding this comment.
also in the third bullet: replace the Open Science Catalog with ESA Open Science Catalogue
| @@ -62,18 +63,21 @@ By following these steps, your research becomes part of a broader ecosystem of r | |||
| ## Step 1: Make Your Data Accessible | |||
|
|
|||
| To contribute to the Open Science Catalog, your research data must be openly accessible and persistent. Begin by preparing your **Research Experiments**, which includes: | |||
|
|
||
| To contribute to the Open Science Catalog, your research data must be openly accessible and persistent. Begin by preparing your **Research Experiments**, which includes: | ||
|
|
||
| - **Data files**, which will be added to the Item Catalog. |
There was a problem hiding this comment.
maybe replace with: "Data files", which will be added to Items collections with links to data assets.
| ```json{3,5,7,12-15,22-23,30-32,49,80,90,}:line-numbers | ||
| { | ||
| "type": "Collection", | ||
| "id": "short-descriptive-product-identifier", |
| ] | ||
| } | ||
| }, | ||
| "license": "proprietary", |
There was a problem hiding this comment.
CC-BY-4.0 would look better in the template I think
| "title": "Documentation" | ||
| }, | ||
| ], | ||
| // STAC extensions for more extensive metadata. Visit their links for more information. |
There was a problem hiding this comment.
Maybe we should provide the links which should be always added (as mandatory) to inform the user that these are the links to be used and additional links may be added if needed.
| "https://stac-extensions.github.io/themes/v1.0.0/schema.json", | ||
| "https://stac-extensions.github.io/cf/v0.2.0/schema.json" | ||
| ], | ||
| "osc:project": "my-project-title", |
There was a problem hiding this comment.
Project name id from the ESA Open Science Catalogue: https://opensciencedata.esa.int/projects/catalog.
| "rel": "child", | ||
| "href": "https://<remote-storage>/my-item-collection/collection.json", // link to your remote Item Collection | ||
| "type": "application/json", | ||
| "title": "Items" |
There was a problem hiding this comment.
we have also this link:
{"rel": "via",
"href": "XXXXX URL with access to the data files (if hosted externally)
"title": "Access"
},
| "rel": "related", | ||
| "href": "../../projects/4d-antarctica/collection.json", | ||
| "type": "application/json", | ||
| "title": "Project: 4D-ANTARCTICA" |
There was a problem hiding this comment.
Provide a title of the Project associated to this dataset (from ESA Open Science Catalogue)
| [ | ||
| "2021-01-01T00:00:00Z", | ||
| "2021-12-31T23:59:59Z" | ||
| ] |
| ``` | ||
| ::: | ||
|
|
||
| You also need to make changes to **all** the collections we have linked to. Below is an example of the changes required for the "ice velocity" variable in the above example. |
There was a problem hiding this comment.
I do not know if this is needed. Maybe we can keep it simple and anyway adding the variables will be done automatically, from the GUI..
| ::: | ||
|
|
||
| ### Example Project Collection | ||
| If this is your first time contributing, your project is likely not yet registered in the Open Science Catalog. In that case, you’ll need to add a proper project description before (or alongside) publishing your product. |
There was a problem hiding this comment.
it is likely that your project is not featured yet in the Open Science Catalogue.
| ] | ||
| } | ||
| }, | ||
| "license": "proprietary", |
There was a problem hiding this comment.
"CC-BY-4.0" replace this in an example
3 participants
