Skip to content

Comments

DSDE-198: docs(era5): readme file#85

Draft
EstebanMontandon wants to merge 2 commits intomainfrom
Review-ERA5-documentation-pipelines
Draft

DSDE-198: docs(era5): readme file#85
EstebanMontandon wants to merge 2 commits intomainfrom
Review-ERA5-documentation-pipelines

Conversation

@EstebanMontandon
Copy link
Contributor

I just created this PR for the purpose of adding my quick review of the ERA5 docs.

New variables can be supported by appending its identifier
to the `variables` list in `era5_extract()`. See documentation of `openhexa.toolbox.era5` for more
info on available variables.
info on available variables. (EM: perhaps here we should add a direct URL link)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the section Suported variables would be handy to add a link to the toolbox documentation :

* `2m_temperature`
* `total_precipitation`
* `volumetric_soil_water_layer_1`
* `volumetric_soil_water_layer_1` (EM: variables supported updated?)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just saw that in the code we have:

@parameter(
    "variable",
    name="Variable",
    type=str,
    choices=[
    	"10 metre U wind component",
    	"10 metre V wind component",
    	"2 metre temperature",
    	"Total precipitation",
    	"Volumetric soil water layer 11",
]

perhaps we need to update this?

## Parameters
## Parameters

(EM: Maybe here we can add a screenshot of the parameters?)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would just add a screenshot with the pipelines parameters filled in as an example... just to keep the same style as other readme files I've seen ;)

@EstebanMontandon
Copy link
Contributor Author

Additional comments:
Overall the descriptions of the functionality is clear and readable (more than enough for people with the correct background I think).

I just had a couple of doubts:

  1. In the case of ERA5 Import DHIS2 Pipeline
    How do you handle the ‘Append’ option? “ Do you make a request for those dataElements and compare dates?

  2. ERA5-Land to DHIS2 Import Pipeline & ERA5-Land Data Synchronization Pipeline
    These two ERA5-Land* pipelines are intended to replace the previous ERA5 implementation of extract->aggregate->import? I have the impression that these two pipelines cover the general use cases correct?

@lgarridobsq lgarridobsq changed the title docs(era5): readme file docs(era5): readme file DSDE-198 Jan 16, 2026
@lgarridobsq lgarridobsq changed the title docs(era5): readme file DSDE-198 DSDE-198: docs(era5): readme file Jan 16, 2026
Copy link
Collaborator

@lgarridobsq lgarridobsq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Holi, I change the name because I wanted to see if I could link it to the JIRA issue this way -- it worked ⭐ remember that doing it by including the jira code in the branch name also works
I let Yann review the PR

@lgarridobsq lgarridobsq marked this pull request as draft January 16, 2026 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants