Skip to content
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.

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

update predefined catalogs (deltares_data & artifact_data) #833

Open
wants to merge 102 commits into
base: main
Choose a base branch
from

Conversation

DirkEilander
Copy link
Contributor

@DirkEilander DirkEilander commented Mar 7, 2024

Issue addressed

Fixes #521 #701 #537

Explanation

Explain how you addressed the bug/feature request, what choices you made and why.

Checklist

  • Updated tests or added new tests
  • Branch is up to date with main
  • Tests & pre-commit hooks pass
  • Updated documentation if needed
  • Updated changelog.rst if needed
  • For predefined catalogs: update the catalog version in the file itself, the references in data/predefined_catalogs.yml, and the changelog in data/changelog.rst

Additional Notes (optional)

Add any additional notes or information that may be helpful.

Tjalling-dejong and others added 30 commits November 9, 2023 17:08
@Tjalling-dejong Tjalling-dejong marked this pull request as ready for review May 15, 2024 15:29
Copy link
Contributor

@hboisgon hboisgon left a comment

Choose a reason for hiding this comment

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

Thanks for the update @Tjalling-dejong ! I focused my review on the content of the data catalogs file themselves and will let @savente93 look at the rest.
I just have a few minor comments so I approve already!

data/catalogs/artifact_data/v0.0.8/data_catalog.yml Outdated Show resolved Hide resolved
data/catalogs/artifact_data/v0.0.8/data_catalog.yml Outdated Show resolved Hide resolved
path: merit_hydro/{variable}.tif

Copy link
Contributor

Choose a reason for hiding this comment

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

I cannot comment the line below but can you update from merit_hydro_1k to merit_hydro_ihu so that it's the same name as in deltares_data?

data/catalogs/deltares_data/v0.7.0/data_catalog.yml Outdated Show resolved Hide resolved
path: rgi.gpkg
rivers_lin2019_v1:

hydro_rivers_lin2019:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
hydro_rivers_lin2019:
hydro_rivers_lin:

I dont think we need 2019 in the name anymore. Can you update in all artifact_data + deltares_data?

path: rgi.gpkg
rivers_lin2019_v1:

rivers_lin2019:
Copy link
Contributor

Choose a reason for hiding this comment

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

update the name so that it is the same in deltares_data

data/catalogs/deltares_data/v0.7.0/data_catalog.yml Outdated Show resolved Hide resolved
data/catalogs/deltares_data/v0.7.0/data_catalog.yml Outdated Show resolved Hide resolved
@@ -704,6 +751,7 @@ soilgrids:
ph_sl5: 0.1
ph_sl6: 0.1
ph_sl7: 0.1

Copy link
Contributor

Choose a reason for hiding this comment

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

Good to harmonise name of vito with deltares_data ie vito to vito_2015

Comment on lines 88 to 94
+--------------------------------+---------------------------+
| esa_worldcover | esa_worldcover_2020 |
+--------------------------------+---------------------------+
| corine | corine_2018 |
+--------------------------------+---------------------------+
| globcover | globcover_2009 |
+--------------------------------+---------------------------+
Copy link
Contributor

Choose a reason for hiding this comment

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

I actually see that you added the year of the landuse map to also in a way match vito. For data like globcover there was really only one year so I dont know if we need to add. For esa_worldcover the 2021 map is actually under a separate version number. And corine I think so far also one map only.
So in a way I don't really mind if you prefer to leave the years after all or not, just make sure they are the same in artifact_data as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

I removed the years in the name of the corine, esa_worldcover, and globcover datasets. It makes more sense if these datasets are from one year only.

Copy link
Contributor

@savente93 savente93 left a comment

Choose a reason for hiding this comment

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

Looks good overall but there are two points where I think we might be breaking existing functionalities, so I want to be sure that we don't before approving. Once that's tested, it should b egood though.

Comment on lines +41 to +44
urlpath: https://raw.githubusercontent.com/Deltares/hydromt/{version}/data/catalogs/artifact_data.yml
versions:
v0.0.8: v0.0.8
v0.0.7: v0.0.7
v0.0.6: v0.0.6
v0.0.9: main
v0.0.8: 202874eb4fe3415d0608ea81cd61620af6f5816a
Copy link
Contributor

Choose a reason for hiding this comment

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

This will break older versions of hydromt I think. So unless very necessary I think this is more something for v1

From CLI
~~~~~~~~

To use a predefined catalog, you can specify the catalog name with the ``--dd`` or ``--data_catalog`` option when running a HydroMT command.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is incorrect. The current code in cli/main.py specifies that --dd is for the detlares data catalog specifically not other predefined catalogs, those are loaded by default if I recall correctly. Can you check this, and update if necessary?

Copy link
Contributor

Choose a reason for hiding this comment

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

Could also be that we need to rework the cli option, but in that case it should also move to v1

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, you're right Sam. I changed it.

docs/user_guide/data_existing_cat.rst Outdated Show resolved Hide resolved
Comment on lines +96 to +104
html-test-skip-examples = { cmd = [
"export",
"SPHINX_SKIP_EXAMPLES=1;",
"sphinx-build",
"-M",
"html",
"docs",
"docs/_build",
] }
Copy link
Contributor

Choose a reason for hiding this comment

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

I like this addition!

Tjalling-dejong and others added 12 commits May 22, 2024 09:54
Co-authored-by: hboisgon <45457510+hboisgon@users.noreply.github.com>
Co-authored-by: hboisgon <45457510+hboisgon@users.noreply.github.com>
Co-authored-by: hboisgon <45457510+hboisgon@users.noreply.github.com>
Co-authored-by: hboisgon <45457510+hboisgon@users.noreply.github.com>
Co-authored-by: hboisgon <45457510+hboisgon@users.noreply.github.com>
Co-authored-by: Sam Vente <savente93@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants