docs: Refactored product storage status into eo product properties #1612
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Code Coverage (Ubuntu)Diff against developResults for commit: 6d1235e Minimum allowed coverage is ♻️ This comment has been updated with latest results |
|
Code Coverage (Windows)Diff against developResults for commit: 6d1235e Minimum allowed coverage is ♻️ This comment has been updated with latest results |
sbrunato
requested changes
Apr 16, 2025
There was a problem hiding this comment.
- linting failed in the CI, I think you might not have installed pre-commit. Please run
pre-commit install, thenpre-commit run -ato update already-submitted files - doc fails to build, please run
tox -e docslocally to check then fix errors - please add to this list
storageStatuswith original info fromdocs/getting_started_guide/product_storage_status.rst - add
idas Unique identifier for the resource, harmonized across providers. - add
tileIdentifier
| - **language**: Language of the resource content. | ||
| - **specification**: Reference to the specification to which the resource conforms. | ||
| - **parentIdentifier**: A string identifying the parent of the entry in a hierarchy of resources. | ||
| - **productionStatus**: A string identifying the status of the entry (e.g., ARCHIVED, ACQUIRED, CANCELLED). |
There was a problem hiding this comment.
Suggested change
| - **productionStatus**: A string identifying the status of the entry (e.g., ARCHIVED, ACQUIRED, CANCELLED). |
Should be removed, see https://eodag.readthedocs.io/en/latest/changelog.html#v1-5-1-2020-04-08
Please also remove remaining occurrences of productionStatus in the code
There was a problem hiding this comment.
please add or comment this suggestion
| - **illuminationZenithAngle**: Illumination zenith angle during acquisition. | ||
| - **illuminationElevationAngle**: Illumination elevation angle during acquisition. | ||
| - **polarizationMode**: Mode of polarization, space-separated (i.e. VV, VV VH, etc). | ||
| - **polarizationChannels**: Channels used for polarization. |
There was a problem hiding this comment.
Suggested change
| - **polarizationChannels**: Channels used for polarization. | |
| - **polarizationChannels**: Channels used for polarization, space-separated (i.e. ``"VV"``, ``"VV VH"``, etc). |
Comment on lines
6
to
9
| EODAG exposes metadata for queryables based on [OGC OpenSearch Extension for Earth Observation](https://docs.ogc.org/is/13-026r9/13-026r9.html) for all providers that support it. | ||
| All of the parameters are string based. If a parameter requires an specific format it will be defined on the list below. | ||
|
|
||
| ---------------------------- |
There was a problem hiding this comment.
Suggested change
| EODAG exposes metadata for queryables based on [OGC OpenSearch Extension for Earth Observation](https://docs.ogc.org/is/13-026r9/13-026r9.html) for all providers that support it. | |
| All of the parameters are string based. If a parameter requires an specific format it will be defined on the list below. | |
| ---------------------------- | |
| EODAG maps each provider's specific metadata parameters to a common model using | |
| `OGC OpenSearch Extension for Earth Observation <http://docs.opengeospatial.org/is/13-026r9/13-026r9.html>`_. | |
| Extra parameters that have no equivalent in this model are mapped as they are. | |
| For more information on parameters mapping, please see `Contributing / Parameters mapping <../params_mapping.rst>`_. | |
| Here is a list of these common mapped properties: |
There was a problem hiding this comment.
please add or comment this suggestion
sbrunato
requested changes
Apr 17, 2025
There was a problem hiding this comment.
- add
idas Unique identifier for the resource, harmonized across providers.
id is still missing
Comment on lines
6
to
9
| EODAG exposes metadata for queryables based on [OGC OpenSearch Extension for Earth Observation](https://docs.ogc.org/is/13-026r9/13-026r9.html) for all providers that support it. | ||
| All of the parameters are string based. If a parameter requires an specific format it will be defined on the list below. | ||
|
|
||
| ---------------------------- |
There was a problem hiding this comment.
please add or comment this suggestion
| * STAGING: the product has been ordered and will be `ONLINE` soon; | ||
| * OFFLINE: the product is not available for download, but can eventually be ordered. | ||
|
|
||
| * ``eodag`` is able to order `OFFLINE` products and retry downloading them for a while. This is described in more details in the `Python API user guide <../notebooks/api_user_guide/8_download.ipynb>`_. |
There was a problem hiding this comment.
please sort properties in alphabetical order
There was a problem hiding this comment.
please add double ticks around properties values to make them more visible (VV,VV VH, ...)
| ---------------------------- | ||
|
|
||
| * **uid**: Unique identifier for the resource, using provider specific formatting. | ||
| * **tileIdentifier**: Tile identifier. |
There was a problem hiding this comment.
Suggested change
| * **tileIdentifier**: Tile identifier. | |
| * **tileIdentifier**: Tile identifier from Sentinel 2 MGRS tiling grid (``31TCJ``, ``17FQE``, ...) |
| * **productionStatus**: A string identifying the status of the entry (e.g., ARCHIVED, ACQUIRED, CANCELLED). | ||
| * **acquisitionType**: Used to distinguish at a high level the appropriateness of the acquisition for general use. Values: NOMINAL, CALIBRATION, OTHER. | ||
| * **orbitNumber**: A number, set, or interval requesting the acquisition orbit. | ||
| * **orbitDirection**: A string identifying the acquisition orbit direction. Possible values: ASCENDING, DESCENDING. |
There was a problem hiding this comment.
please do not list possible values as we do not harmonize them for the moment
| * **specification**: Reference to the specification to which the resource conforms. | ||
| * **parentIdentifier**: A string identifying the parent of the entry in a hierarchy of resources. | ||
| * **productionStatus**: A string identifying the status of the entry (e.g., ARCHIVED, ACQUIRED, CANCELLED). | ||
| * **acquisitionType**: Used to distinguish at a high level the appropriateness of the acquisition for general use. Values: NOMINAL, CALIBRATION, OTHER. |
There was a problem hiding this comment.
please do not list possible values as we do not harmonize them for the moment
Co-authored-by: Sylvain Brunato <[email protected]>
Co-authored-by: Sylvain Brunato <[email protected]>
|
The page is not user friendly at all as is. We'll postpone the completion of this PR until properties are STAC-formatted. This will give the possibility to sort properties by category / STAC extension |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Repurposing the old page to describe the EO Open Search parameters.