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

Documentation on how to find shapefiles for hydrology recipes #1777

Merged
merged 4 commits into from Aug 3, 2020

Conversation

JaroCamphuijsen
Copy link
Contributor

@JaroCamphuijsen JaroCamphuijsen commented Aug 3, 2020

Before you start, please read our contribution guidelines.

Please discuss your idea with the development team before getting started, to avoid disappointment later. The way to do this is to open a new issue on GitHub. If you are planning to modify an existing functionality, please discuss it with the original author(s) by tagging them in the issue.


Tasks

  • Create an issue to discuss what you are going to do, if you haven't done so already (and add the link at the bottom)
  • Give this pull request a descriptive title that can be used as a one line summary in a changelog
  • Make sure your code is composed of functions of no more than 50 lines and uses meaningful names for variables
  • Circle/CI tests pass. Status can be seen below your pull request. If the tests are failing, click the link to find out why.
  • Preferably Codacy code quality checks pass, however a few remaining hard to solve Codacy issues are still acceptable. Status can be seen below your pull request. If there is an error, click the link to find out why. If you suspect Codacy may be wrong, please ask by commenting.
  • Please use yamllint to check that your YAML files do not contain mistakes
  • (Only if really necessary) Add any additional dependencies needed for the diagnostic script to setup.py, esmvaltool/install/R/r_requirements.txt or esmvaltool/install/Julia/Project.toml (depending on the language of your script) and also to package/meta.yaml for conda dependencies (includes Python and others, but not R/Julia)
  • If new dependencies are introduced, check that the license is compatible with Apache2.0

New recipe/diagnostic

  • Add documentation for the recipe to the doc/sphinx/source/recipes folder and add a new entry to index.rst
  • Add provenance information

Modified recipe/diagnostic

  • Update documentation for the recipe to the doc/sphinx/source/recipes folder
  • Update provenance information if needed
  • Assign the author(s) of the affected recipe(s) as reviewer(s)

New data reformatting script

  • Test the CMORized data using recipes/example/recipe_check_obs.yml, to make sure the CMOR checks pass without errors
  • Add the new dataset to the table in the documentation
  • Tag @mattiarighi in this pull request, so that the new dataset can be added to the OBS data pool at DKRZ and synchronized with CEDA-Jasmin

Modified data reformatting script

  • Test the CMORized data using recipes/example/recipe_check_obs.yml, to make sure the CMOR checks pass without errors
  • Tag @mattiarighi in this pull request, so that the updated dataset can be added to the OBS data pool at DKRZ and synchronized with CEDA-Jasmin

If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.


Closes #1762

Co-authored-by: SarahAlidoost <55081872+SarahAlidoost@users.noreply.github.com>
Copy link
Contributor

@SarahAlidoost SarahAlidoost left a comment

@JaroCamphuijsen Thank you, I suggested some minor revisions.

@JaroCamphuijsen JaroCamphuijsen requested a review from bouweandela Aug 3, 2020
@JaroCamphuijsen JaroCamphuijsen changed the title Documentation on how to find shapefiles Documentation on how to find shapefiles for hydrology recipes Aug 3, 2020
@JaroCamphuijsen
Copy link
Contributor Author

JaroCamphuijsen commented Aug 3, 2020

@bouweandela can you merge this?

Co-authored-by: Bouwe Andela <b.andela@esciencecenter.nl>
@bouweandela bouweandela merged commit 5143e9e into master Aug 3, 2020
1 check passed
@bouweandela bouweandela deleted the ewatercycle_shapefile_documentation branch Aug 3, 2020
bouweandela added a commit that referenced this pull request Aug 3, 2020
Co-authored-by: SarahAlidoost <55081872+SarahAlidoost@users.noreply.github.com>
Co-authored-by: Bouwe Andela <b.andela@esciencecenter.nl>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reference to HydroSHEDS in Hydrology recipe documentation.
3 participants