Draft of the Training Website #1
Conversation
Updates to Social Impact
updates to social impact
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (27)
docs/Accessing-Data/bulk-download.md (1)
15-15: Correct the grammatical structure.The sentence "Please review the tutorial on Finding River Numbers for help identifying streams and VPU numbers." should be revised for clarity.
Consider rephrasing to:
- Please review the tutorial on [Finding River Numbers](https://data.geoglows.org/tutorials/finding-river-numbers) for help identifying streams and VPU numbers. + Please review the tutorial on [Finding River Numbers](https://data.geoglows.org/tutorials/finding-river-numbers) to help identify streams and VPU numbers.Tools
LanguageTool
[grammar] ~15-~15: The verb ‘help’ is used with an infinitive.
Context: ...torials/finding-river-numbers) for help identifying streams and VPU numbers. The CLI comman...(ADVISE_VBG)
docs/Accessing-Data/hydroviewer.md (1)
11-11: Remove trailing punctuation from headings.Headings should not have trailing punctuation for consistency and to adhere to markdownlint rules.
Consider removing the colons:
- ## Features: + ## Features - ## Benefits: + ## Benefits - ## Target Users: + ## Target Users - ### Note: + ### NoteAlso applies to: 18-18, 25-25, 32-32
Tools
Markdownlint
11-11: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
docs/Retrospective-Data/bias_correct.md (1)
3-3: Adjust heading levels for consistency.The heading "Introduction" is a level 4 heading but should be a level 2 heading to maintain a consistent hierarchy.
Consider changing the heading level:
- #### Introduction + ## IntroductionTools
Markdownlint
3-3: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
docs/Accessing-Data/data-sources.md (2)
25-25: Correct grammatical structure.The sentence "The data module provides functions for requesting forecasted and historical data river discharge simulations." is missing a preposition.
Consider rephrasing to:
- The data module provides functions for requesting forecasted and historical data river discharge simulations. + The data module provides functions for requesting forecasted and historical river discharge data simulations.Tools
LanguageTool
[uncategorized] ~25-~25: Possible missing preposition found.
Context: ...questing forecasted and historical data river discharge simulations. The data can be ...(AI_HYDRA_LEO_MISSING_OF)
31-31: Add a comma for clarity.The sentence "It is called LINKNO in GEOGLOWS which uses the TDX-Hydro streams dataset." is missing a comma after "GEOGLOWS."
Consider adding a comma:
- It is called LINKNO in GEOGLOWS which uses the TDX-Hydro streams dataset. + It is called LINKNO in GEOGLOWS, which uses the TDX-Hydro streams dataset.Tools
LanguageTool
[uncategorized] ~31-~31: Possible missing comma found.
Context: ...etwork dataset. It is called LINKNO in GEOGLOWS which uses the TDX-Hydro streams datase...(AI_HYDRA_LEO_MISSING_COMMA)
docs/index.md (1)
38-45: Fix unordered list indentation.The unordered list items for the surveys are not properly indented.
Fix the indentation as follows:
- * [English Survey](https://forms.gle/eZr1nARB5L2kvMGy9) - * [Español Survey](https://forms.gle/gjUedjP74PVb368w5) +* [English Survey](https://forms.gle/eZr1nARB5L2kvMGy9) +* [Español Survey](https://forms.gle/gjUedjP74PVb368w5)Tools
Markdownlint
44-44: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
45-45: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
docs/Forecast-Data/forecast_validation.md (4)
1-19: Consider removing "of" for conciseness.In line 37, consider removing "of" to make the sentence more concise.
Fix the sentence as follows:
- All of the observed data should be in the folder on your Google Drive called ‘Forecast_Validation/Country/’ + All the observed data should be in the folder on your Google Drive called ‘Forecast_Validation/Country/’
41-41: Add missing comma for clarity.A comma is missing in line 41 after "In this example".
Fix the sentence as follows:
- In this example we are following the GEOGloWS ECMWF Streamflow Services (GESS) Forecast Validation + In this example, we are following the GEOGloWS ECMWF Streamflow Services (GESS) Forecast ValidationTools
LanguageTool
[typographical] ~41-~41: It appears that a comma is missing.
Context: ...mn header “Streamflow (m3/s).” In this example we are following the GEOGloWS ECMWF Str...(DURING_THAT_TIME_COMMA)
21-26: Fix bare URL usage.The reference link uses a bare URL, which is not recommended.
Fix the markdown as follows:
- This [Google Colab notebook][4] will allow you to download the forecast data. - [4]: https://colab.research.google.com/drive/1y2eVRJpfcdISB25U0lCBZ7z6up14wswg + This [Google Colab notebook](https://colab.research.google.com/drive/1y2eVRJpfcdISB25U0lCBZ7z6up14wswg) will allow you to download the forecast data.
43-43: Fix bare URL usage.The reference link uses a bare URL, which is not recommended.
Fix the markdown as follows:
- The Colab notebook is available here: https://colab.research.google.com/drive/1VMs50wKE55TBn8tWTimc69s1rNaom8SI + The Colab notebook is available [here](https://colab.research.google.com/drive/1VMs50wKE55TBn8tWTimc69s1rNaom8SI).Tools
Markdownlint
43-43: null
Bare URL used(MD034, no-bare-urls)
docs/Retrospective-Data/historical_validation.md (5)
1-3: Fix heading level increment.The heading level should increment by one level at a time.
Fix the heading as follows:
- ### Introduction + ## IntroductionTools
Markdownlint
3-3: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
15-15: Add missing comma for clarity.A comma is missing in line 15 after "After that".
Fix the sentence as follows:
- After that, the runoff is resampled performing an area-weighted grid-to-vector downscaling + After that, the runoff is resampled, performing an area-weighted grid-to-vector downscalingTools
LanguageTool
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...TESSEL model. After that, the runoff is resampled performing an area-weighted grid-to-vec...(AI_HYDRA_LEO_MISSING_COMMA)
19-19: Consider using "are" instead of "is".In line 19, consider using "are" to match the plural subject "tools".
Fix the sentence as follows:
- Hydrostats is an open-source software package designed to support hydrologic model evaluation. + Hydrostats are an open-source software package designed to support hydrologic model evaluation.Tools
LanguageTool
[grammar] ~19-~19: Did you mean “are” or “were”?
Context: ...n results to observed data. Hydrostats is an open-source software package designe...(SENT_START_NNS_IS)
26-26: Add missing comma for clarity.A comma is missing in line 26 after "any title".
Fix the sentence as follows:
- The other may have any title but must contain streamflow values in cubic meters per second (m^3/s). + The other may have any title, but must contain streamflow values in cubic meters per second (m^3/s).Tools
LanguageTool
[uncategorized] ~26-~26: Possible missing comma found.
Context: ...ard format. The other may have any title but must contain streamflow values in cubic...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
26-26: null
Bare URL used(MD034, no-bare-urls)
35-35: Use a hyphen in "case-sensitive".The term "case sensitive" should be hyphenated.
Fix the sentence as follows:
- Login with the Demo Account (case sensitive) + Login with the Demo Account (case-sensitive)Tools
LanguageTool
[misspelling] ~35-~35: This word is normally spelled with a hyphen.
Context: ...ats App 3. Login with the Demo Account (case sensitive) * Username: demo * Password: demo ## ...(EN_COMPOUNDS_CASE_SENSITIVE)
docs/Accessing-Data/data-aws.md (6)
3-5: Consider using "streamlines" as one word.In line 5, "Stream lines" is typically written as "streamlines".
Fix the text as follows:
- | Stream lines and catchments (geopackage) | s3://geoglows-v2 | streams | + | Streamlines and catchments (geopackage) | s3://geoglows-v2 | streams |Tools
LanguageTool
[grammar] ~5-~5: This is normally spelled as one word.
Context: ...--------------|---------------------| | Stream lines and catchments (geopackage) | ...(LINE_COMPOUNDS)
18-18: Consider using "username" as one word.In line 18, "user name" is typically written as "username".
Fix the text as follows:
- You do not need an AWS account, credit card, or a user name and password to use this AWS service + You do not need an AWS account, credit card, or a username and password to use this AWS serviceTools
LanguageTool
[style] ~18-~18: It’s more common nowadays to write this noun as one word.
Context: ... need an AWS account, credit card, or a user name and password to use this AWS service to...(RECOMMENDED_COMPOUNDS)
27-27: Fix bare URL usage.The reference link uses a bare URL, which is not recommended.
Fix the markdown as follows:
- * http://geoglows-v2.s3-website-us-west-2.amazonaws.com/ + * [Model configurations and GIS datasets](http://geoglows-v2.s3-website-us-west-2.amazonaws.com/)Tools
Markdownlint
27-27: null
Bare URL used(MD034, no-bare-urls)
31-31: Use a hyphen in "post-processing".The term "post processing" should be hyphenated.
Fix the text as follows:
- * TDX-Hydro post processing preparation for hydrological modeling: https://github.com/geoglows/tdxhydro-postprocessing + * TDX-Hydro post-processing preparation for hydrological modeling: https://github.com/geoglows/tdxhydro-postprocessingTools
LanguageTool
[misspelling] ~31-~31: This word is normally spelled with a hyphen.
Context: ...nal code used in GEOGLOWS: * TDX-Hydro post processing preparation for hydrological modeling: ...(EN_COMPOUNDS_POST_PROCESSING)
Markdownlint
31-31: null
Bare URL used(MD034, no-bare-urls)
42-42: Fix bare URL usage.The reference link uses a bare URL, which is not recommended.
Fix the markdown as follows:
- * http://geoglows-v2-forecasts.s3-website-us-west-2.amazonaws.com/ + * [Daily forecast outputs](http://geoglows-v2-forecasts.s3-website-us-west-2.amazonaws.com/)Tools
Markdownlint
42-42: null
Bare URL used(MD034, no-bare-urls)
45-45: Consider using an en dash for ranges.In line 45, consider using an en dash for the range "1-2 weeks".
Fix the text as follows:
- You should notice the historical simulation alternates between 1-2 weeks of lag from real time. + You should notice the historical simulation alternates between 1–2 weeks of lag from real time.Tools
LanguageTool
[typographical] ~45-~45: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...istorical simulation alternates between 1-2 weeks of lag from real time. * http:/...(HYPHEN_TO_EN)
docs/social-impact.md (6)
12-12: Consider using "public" for conciseness.In line 12, consider using "public" instead of "general public" to avoid wordiness.
Fix the sentence as follows:
- including scientists, policymakers, and the general public. + including scientists, policymakers, and the public.Tools
LanguageTool
[style] ~12-~12: Consider using only “public” to avoid wordiness.
Context: ...uding scientists, policymakers, and the general public. This paper highlights the importance o...(GENERAL_XX)
66-66: Add missing comma for clarity.A comma is missing in line 66 after "Center for Hydrology".
Fix the sentence as follows:
- Brigham Young University’s Ballard Center for Hydrology and it is based on the slogan + Brigham Young University’s Ballard Center for Hydrology, and it is based on the sloganTools
LanguageTool
[uncategorized] ~66-~66: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...niversity’s Ballard Center for Hydrology and it is based on the slogan “Love the Pro...(COMMA_COMPOUND_SENTENCE)
[style] ~66-~66: Consider an alternative adjective to strengthen your wording.
Context: ...on, addressing the solution based on a deeper understanding of the problem by creatin...(DEEP_PROFOUND)
46-48: Reword repetitive sentence beginnings.Consider rewording the sentences in lines 46-48 to avoid repetition.
Fix the sentences as follows:
- What will you improve? - What problem will you address? - What steps will you take? - How will you measure success? - How can you increase impact? + What improvements will you make? + Which problem will you address? + Which steps will you take? + How will success be measured? + How can impact be increased?Tools
LanguageTool
[style] ~46-~46: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e? - What problem will you address? - What steps will you take? - How will you me...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
98-98: Add missing comma for clarity.A comma is missing in line 98 after "Theory of Change".
Fix the sentence as follows:
- When we initially create a Theory of Change we organize what we learn into five fundamental categories: + When we initially create a Theory of Change, we organize what we learn into five fundamental categories:Tools
LanguageTool
[uncategorized] ~98-~98: Possible missing comma found.
Context: ...* When we initially create a Theory of Change we organize what we learn into five fun...(AI_HYDRA_LEO_MISSING_COMMA)
154-154: Consider removing "of" for conciseness.In line 154, consider removing "of" to make the sentence more concise.
Fix the sentence as follows:
- which includes identifying all of the key players, environmental conditions, and the relationships among them. + which includes identifying all the key players, environmental conditions, and the relationships among them.Tools
LanguageTool
[style] ~154-~154: Consider removing “of” to be more concise
Context: ...r ecosystem, which includes identifying all of the key players, environmental conditions, ...(ALL_OF_THE)
[style] ~154-~154: Consider a shorter alternative to avoid wordiness.
Context: ...ct and outline the steps they will take in order to achieve that impact, which is defining ...(IN_ORDER_TO_PREMIUM)
171-171: Add missing comma for clarity.A comma is missing in line 171 after "social problem".
Fix the sentence as follows:
- If the result is a measurement of the negative consequences of the social problem then the result is an outcome. + If the result is a measurement of the negative consequences of the social problem, then the result is an outcome.Tools
LanguageTool
[uncategorized] ~171-~171: Possible missing comma found.
Context: ...the negative consequences of the social problem then the result is an outcome. All othe...(AI_HYDRA_LEO_MISSING_COMMA)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (17)
docs/Accessing-Data/image1.pngis excluded by!**/*.pngdocs/Accessing-Data/image2.pngis excluded by!**/*.pngdocs/Accessing-Data/image5.pngis excluded by!**/*.pngdocs/Accessing-Data/img6.pngis excluded by!**/*.pngdocs/Forecast-Data/screenshot.pngis excluded by!**/*.pngdocs/Retrospective-Data/image4.pngis excluded by!**/*.pngdocs/image3.pngis excluded by!**/*.pngdocs/images/Aproximity_Affinity.pngis excluded by!**/*.pngdocs/images/Expand_ToC.pngis excluded by!**/*.pngdocs/images/SOCIAL_CYCLE.pngis excluded by!**/*.pngdocs/images/ToC.pngis excluded by!**/*.pngdocs/images/Use_Cases_CR_Ecuador.pngis excluded by!**/*.pngdocs/images/Users.pngis excluded by!**/*.pngdocs/images/beyond_boundaries.jpgis excluded by!**/*.jpgdocs/images/geoglows_ecosystem_map.pngis excluded by!**/*.pngdocs/images/logic_model.pngis excluded by!**/*.pngdocs/images/pillars_geoglows.pngis excluded by!**/*.png
Files selected for processing (13)
- docs/Accessing-Data/bulk-download.md (1 hunks)
- docs/Accessing-Data/data-aws.md (1 hunks)
- docs/Accessing-Data/data-sources.md (1 hunks)
- docs/Accessing-Data/hydrofabric.md (1 hunks)
- docs/Accessing-Data/hydroviewer.md (1 hunks)
- docs/Accessing-Data/programmatic-access.md (1 hunks)
- docs/Forecast-Data/forecast_validation.md (1 hunks)
- docs/Retrospective-Data/bias_correct.md (1 hunks)
- docs/Retrospective-Data/deriv.md (1 hunks)
- docs/Retrospective-Data/historical_validation.md (1 hunks)
- docs/index.md (1 hunks)
- docs/social-impact.md (1 hunks)
- mkdocs.yml (1 hunks)
Files skipped from review due to trivial changes (3)
- docs/Accessing-Data/hydrofabric.md
- docs/Accessing-Data/programmatic-access.md
- docs/Retrospective-Data/deriv.md
Additional context used
LanguageTool
docs/Accessing-Data/bulk-download.md
[grammar] ~15-~15: The verb ‘help’ is used with an infinitive.
Context: ...torials/finding-river-numbers) for help identifying streams and VPU numbers. The CLI comman...(ADVISE_VBG)
docs/Accessing-Data/data-sources.md
[uncategorized] ~25-~25: Possible missing preposition found.
Context: ...questing forecasted and historical data river discharge simulations. The data can be ...(AI_HYDRA_LEO_MISSING_OF)
[uncategorized] ~31-~31: Possible missing comma found.
Context: ...etwork dataset. It is called LINKNO in GEOGLOWS which uses the TDX-Hydro streams datase...(AI_HYDRA_LEO_MISSING_COMMA)
docs/Forecast-Data/forecast_validation.md
[style] ~37-~37: Consider removing “of” to be more concise
Context: ...our Google Drive in the correct format. All of the observed data should be in the folder o...(ALL_OF_THE)
[typographical] ~41-~41: It appears that a comma is missing.
Context: ...mn header “Streamflow (m3/s).” In this example we are following the GEOGloWS ECMWF Str...(DURING_THAT_TIME_COMMA)
docs/Retrospective-Data/historical_validation.md
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...TESSEL model. After that, the runoff is resampled performing an area-weighted grid-to-vec...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~19-~19: Did you mean “are” or “were”?
Context: ...n results to observed data. Hydrostats is an open-source software package designe...(SENT_START_NNS_IS)
[uncategorized] ~26-~26: Possible missing comma found.
Context: ...ard format. The other may have any title but must contain streamflow values in cubic...(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~35-~35: This word is normally spelled with a hyphen.
Context: ...ats App 3. Login with the Demo Account (case sensitive) * Username: demo * Password: demo ## ...(EN_COMPOUNDS_CASE_SENSITIVE)
docs/Accessing-Data/data-aws.md
[grammar] ~5-~5: This is normally spelled as one word.
Context: ...--------------|---------------------| | Stream lines and catchments (geopackage) | ...(LINE_COMPOUNDS)
[style] ~18-~18: It’s more common nowadays to write this noun as one word.
Context: ... need an AWS account, credit card, or a user name and password to use this AWS service to...(RECOMMENDED_COMPOUNDS)
[misspelling] ~31-~31: This word is normally spelled with a hyphen.
Context: ...nal code used in GEOGLOWS: * TDX-Hydro post processing preparation for hydrological modeling: ...(EN_COMPOUNDS_POST_PROCESSING)
[typographical] ~45-~45: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...istorical simulation alternates between 1-2 weeks of lag from real time. * http:/...(HYPHEN_TO_EN)
[uncategorized] ~76-~76: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use cases. Downloading this data is free and you are welcome to do so, but we encour...(COMMA_COMPOUND_SENTENCE)
[grammar] ~86-~86: The verb ‘help’ is used with an infinitive.
Context: ...orial on Finding River Numbers for help identifying streams and VPU numbers. The CLI comman...(ADVISE_VBG)
docs/social-impact.md
[style] ~12-~12: Consider using only “public” to avoid wordiness.
Context: ...uding scientists, policymakers, and the general public. This paper highlights the importance o...(GENERAL_XX)
[style] ~46-~46: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e? - What problem will you address? - What steps will you take? - How will you me...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~66-~66: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...niversity’s Ballard Center for Hydrology and it is based on the slogan “Love the Pro...(COMMA_COMPOUND_SENTENCE)
[style] ~66-~66: Consider an alternative adjective to strengthen your wording.
Context: ...on, addressing the solution based on a deeper understanding of the problem by creatin...(DEEP_PROFOUND)
[uncategorized] ~77-~77: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... using it. Imagine you’re baking a cake and you’ve never baked anything before, but...(COMMA_COMPOUND_SENTENCE)
[style] ~79-~79: Consider using a different verb for a more formal wording.
Context: ...m, we tend to get impatient and want to fix this problem as quickly as we can. This...(FIX_RESOLVE)
[style] ~79-~79: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ere understanding social impact becomes very important. Theory of Change for Hydrology ![...(EN_WEAK_ADJECTIVE)
[style] ~91-~91: ‘make an effort’ might be wordy. Consider a shorter alternative.
Context: ...g the Theory of Change this way, we can make an effort to ensure that developers as implemente...(EN_WORDINESS_PREMIUM_MAKE_AN_EFFORT)
[uncategorized] ~98-~98: Possible missing comma found.
Context: ...* When we initially create a Theory of Change we organize what we learn into five fun...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~101-~101: Consider a shorter alternative to avoid wordiness.
Context: ...l categories: 1.Identify the Problem In order to identify the problem, you must begin by...(IN_ORDER_TO_PREMIUM)
[style] ~108-~108: Consider an alternative to avoid wordiness and to strengthen your wording.
Context: ...in a way that helps us to move forward. In the beginning, all we need is a desire and a willingn...(IN_THE_BEGINNING_INITIALLY)
[formatting] ~108-~108: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...ed is a desire and a willingness to help, because there is so much to learn about the pro...(COMMA_BEFORE_BECAUSE)
[style] ~108-~108: The phrase “take into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...earn more about the problem, you should take into consideration what the quality and feasibility of the...(TAKE_INTO_CONSIDERATION)
[style] ~118-~118: Consider a shorter alternative to avoid wordiness.
Context: ... one context might not work in another. In order to comprehend the context of a given probl...(IN_ORDER_TO_PREMIUM)
[style] ~130-~130: ‘readily apparent’ might be wordy. Consider a shorter alternative.
Context: ...pear effortless with obvious causes and readily apparent solutions. Upon closer examination, we ...(EN_WORDINESS_PREMIUM_READILY_APPARENT)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...ation, we can discover hidden obstacles that when put together, cause our societal p...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~143-~143: Possible missing comma found.
Context: ...periences of those most impacted by the problem as well as those involved in its soluti...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~154-~154: Consider removing “of” to be more concise
Context: ...r ecosystem, which includes identifying all of the key players, environmental conditions, ...(ALL_OF_THE)
[style] ~154-~154: Consider a shorter alternative to avoid wordiness.
Context: ...ct and outline the steps they will take in order to achieve that impact, which is defining ...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~171-~171: Possible missing comma found.
Context: ...the negative consequences of the social problem then the result is an outcome. All othe...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
docs/Accessing-Data/hydroviewer.md
11-11: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
18-18: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
25-25: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
32-32: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
docs/Retrospective-Data/bias_correct.md
3-3: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
docs/index.md
44-44: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
45-45: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
docs/Forecast-Data/forecast_validation.md
43-43: null
Bare URL used(MD034, no-bare-urls)
docs/Retrospective-Data/historical_validation.md
3-3: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
26-26: null
Bare URL used(MD034, no-bare-urls)
28-28: null
Bare URL used(MD034, no-bare-urls)
28-28: null
Bare URL used(MD034, no-bare-urls)
33-33: null
Bare URL used(MD034, no-bare-urls)
docs/Accessing-Data/data-aws.md
56-56: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
58-58: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
60-60: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
29-29: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
74-74: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
20-20: null
Bare URL used(MD034, no-bare-urls)
22-22: null
Bare URL used(MD034, no-bare-urls)
27-27: null
Bare URL used(MD034, no-bare-urls)
31-31: null
Bare URL used(MD034, no-bare-urls)
33-33: null
Bare URL used(MD034, no-bare-urls)
35-35: null
Bare URL used(MD034, no-bare-urls)
37-37: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
47-47: null
Bare URL used(MD034, no-bare-urls)
67-67: null
Bare URL used(MD034, no-bare-urls)
69-69: null
Bare URL used(MD034, no-bare-urls)
71-71: null
Bare URL used(MD034, no-bare-urls)
78-78: null
Bare URL used(MD034, no-bare-urls)
docs/social-impact.md
10-10: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
15-15: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
20-20: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
26-26: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
96-96: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
147-147: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
152-152: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
159-159: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
173-173: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
196-196: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
200-200: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
204-204: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Additional comments not posted (8)
mkdocs.yml (1)
1-32: Navigation structure and site name update approved.The changes enhance the organization and accessibility of the documentation, aligning with the project's goals.
docs/index.md (5)
1-8: LGTM!The introduction to GEOGLOWS is clear and informative. The markdown syntax for the image and link is correct.
5-10: LGTM!The overview provides a concise description of GEOGLOWS and its offerings. The markdown syntax is correct.
15-18: LGTM!The history section is succinct and provides a relevant link. The markdown syntax is correct.
20-22: LGTM!The model formulation section is clear and provides a useful link. The markdown syntax is correct.
24-28: LGTM!The data components are clearly listed. The markdown syntax is correct.
docs/Forecast-Data/forecast_validation.md (2)
44-46: LGTM!The instructions for reorganizing forecast data are clear and well-structured.
48-52: LGTM!The section is clear, and the image is appropriately referenced.
| * Username: demo | ||
| * Password: demo | ||
|
|
||
| ## Preprocessing |
There was a problem hiding this comment.
Is content missing in the "Preprocessing" section?
The section is currently empty. If content is intended, please add it.
Would you like me to help draft content for this section or open a GitHub issue to track this task?
|
|
||
| ## Preprocessing | ||
|
|
||
| ## Visualization |
There was a problem hiding this comment.
Is content missing in the "Visualization" section?
The section is currently empty. If content is intended, please add it.
Would you like me to help draft content for this section or open a GitHub issue to track this task?
There was a problem hiding this comment.
- Replace all "GEOGloWS" with "GEOGLOWS"
- Replace all "ERA-5" with "ERA5"
- Replace all "GEOGLOWS Hydroviewer" with "Hydroviewer"
- Remove all references to application stories and the nav heading
- Delete all blank pages
- Delete all nav headings
- Make a nav heading for workshops
- Make a nav heading for Presentations
- Put non-blank pages in the correct location under presentations or workshops
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (13)
docs/overview.md (1)
44-45: Fix unordered list indentation.The unordered list items are not properly indented.
Apply this diff to fix the indentation:
* [English Survey](https://forms.gle/eZr1nARB5L2kvMGy9) * [Español Survey](https://forms.gle/gjUedjP74PVb368w5)Tools
Markdownlint
44-44: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
45-45: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
docs/forecast.md (4)
3-8: Remove trailing punctuation from headings.Headings should not have trailing punctuation.
Apply this diff to remove the trailing punctuation:
## Ensembles: ## Statistics: ## Initialization: ## Bias Correction from Historical Data: ## Validation:Tools
Markdownlint
3-3: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
5-5: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
6-6: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
7-7: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
8-8: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
51-51: Format the bare URL as a link.The bare URL should be formatted as a clickable link.
Apply this diff to format the URL:
- The Colab notebook is available here: https://colab.research.google.com/drive/1VMs50wKE55TBn8tWTimc69s1rNaom8SI + The Colab notebook is available [here](https://colab.research.google.com/drive/1VMs50wKE55TBn8tWTimc69s1rNaom8SI).Tools
Markdownlint
51-51: null
Bare URL used(MD034, no-bare-urls)
45-45: Consider removing "of" for conciseness.The phrase "All of the observed data" can be more concise.
Apply this diff to improve conciseness:
- All of the observed data should be in the folder on your Google Drive called ‘Forecast_Validation/Country/’ + All observed data should be in the folder on your Google Drive called ‘Forecast_Validation/Country/’Tools
LanguageTool
[style] ~45-~45: Consider removing “of” to be more concise
Context: ...our Google Drive in the correct format. All of the observed data should be in the folder o...(ALL_OF_THE)
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...Forecast_Validation/Country/’ (for this example the country is Honduras, so it would be...(AI_HYDRA_LEO_MISSING_COMMA)
45-45: Add a missing comma for clarity.A comma is missing after "for this example."
Apply this diff to add the missing comma:
- (for this example the country is Honduras, so it would be ‘Forecast_Validation/Honduras/’). + (for this example, the country is Honduras, so it would be ‘Forecast_Validation/Honduras/’).Tools
LanguageTool
[style] ~45-~45: Consider removing “of” to be more concise
Context: ...our Google Drive in the correct format. All of the observed data should be in the folder o...(ALL_OF_THE)
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...Forecast_Validation/Country/’ (for this example the country is Honduras, so it would be...(AI_HYDRA_LEO_MISSING_COMMA)
docs/accessing-data.md (2)
15-15: Remove trailing punctuation in heading.The "Features:" heading should not have a trailing colon.
Apply this diff to correct the heading:
-### Features: +### FeaturesTools
Markdownlint
15-15: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
17-17: Clarify the invalid URL mention.The text mentions an "invalid URL removed" without providing context. Consider explaining or removing this reference.
docs/retrospective.md (6)
3-3: Remove trailing punctuation in heading.The "Derivation:" heading should not have a trailing colon.
Apply this diff to correct the heading:
-## Derivation: +## DerivationTools
Markdownlint
3-3: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
15-15: Remove trailing punctuation in heading.The "Return Periods & Daily Data:" heading should not have a trailing colon.
Apply this diff to correct the heading:
-## Return Periods & Daily Data: +## Return Periods & Daily DataTools
Markdownlint
15-15: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
16-16: Remove trailing punctuation in heading.The "Historical Validation:" heading should not have a trailing colon.
Apply this diff to correct the heading:
-## Historical Validation: +## Historical ValidationTools
Markdownlint
16-16: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
64-64: Correct heading level and remove trailing punctuation.The heading level should be consistent, and the trailing colon should be removed.
Apply this diff to correct the heading:
-#### Introduction +### IntroductionTools
Markdownlint
64-64: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
37-42: Avoid using bare URLs.Consider using markdown links for better readability.
Apply this diff to replace bare URLs with markdown links:
1. Use this link to download the demo historical observed data: [Download Observed Data](https://www.hydroshare.org/resource/d222676fbd984a81911761ca1ba936bf/data/contents/Discharge_Data/23187280.csv) 2. To get the historical simulation data, go to this url, which will access the API and download the historical simulation: [Download Historical Simulation](https://geoglows.ecmwf.int/api/HistoricSimulation/?reach_id=9004355&return_format=csv)Tools
Markdownlint
40-40: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
44-49: Correct grammar and avoid using bare URLs.The word "Login" should be "Log in," and consider using markdown links for better readability.
Apply this diff to correct the grammar and replace the bare URL:
3. Log in with the Demo Account (case-sensitive) 1. Go to [GEOGLOWS Apps](http://apps.geoglows.org/apps/)Tools
LanguageTool
[misspelling] ~49-~49: This word is normally spelled with a hyphen.
Context: ...ats App 3. Login with the Demo Account (case sensitive) * Username: demo * Password: demo ## ...(EN_COMPOUNDS_CASE_SENSITIVE)
Markdownlint
47-47: null
Bare URL used(MD034, no-bare-urls)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (6)
docs/image1.pngis excluded by!**/*.pngdocs/image2.pngis excluded by!**/*.pngdocs/image4.pngis excluded by!**/*.pngdocs/image5.pngis excluded by!**/*.pngdocs/img6.pngis excluded by!**/*.pngdocs/screenshot.pngis excluded by!**/*.png
Files selected for processing (6)
- docs/accessing-data.md (1 hunks)
- docs/forecast.md (1 hunks)
- docs/index.md (1 hunks)
- docs/overview.md (1 hunks)
- docs/retrospective.md (1 hunks)
- mkdocs.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- docs/index.md
Additional context used
Markdownlint
docs/overview.md
44-44: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
45-45: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
docs/forecast.md
3-3: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
5-5: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
6-6: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
7-7: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
8-8: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
51-51: null
Bare URL used(MD034, no-bare-urls)
docs/accessing-data.md
15-15: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
22-22: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
29-29: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
36-36: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
docs/retrospective.md
64-64: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
3-3: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
15-15: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
16-16: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
60-60: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
110-110: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
40-40: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
47-47: null
Bare URL used(MD034, no-bare-urls)
108-108: Duplicate link or image reference definition: "1"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
LanguageTool
docs/forecast.md
[style] ~45-~45: Consider removing “of” to be more concise
Context: ...our Google Drive in the correct format. All of the observed data should be in the folder o...(ALL_OF_THE)
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...Forecast_Validation/Country/’ (for this example the country is Honduras, so it would be...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~49-~49: It appears that a comma is missing.
Context: ...mn header “Streamflow (m3/s).” In this example we are following the GEOGloWS ECMWF Str...(DURING_THAT_TIME_COMMA)
docs/accessing-data.md
[grammar] ~73-~73: The verb ‘help’ is used with an infinitive.
Context: ...torials/finding-river-numbers) for help identifying streams and VPU numbers. The CLI comman...(ADVISE_VBG)
docs/retrospective.md
[grammar] ~33-~33: Did you mean “are” or “were”?
Context: ...n results to observed data. Hydrostats is an open-source software package designe...(SENT_START_NNS_IS)
[misspelling] ~49-~49: This word is normally spelled with a hyphen.
Context: ...ats App 3. Login with the Demo Account (case sensitive) * Username: demo * Password: demo ## ...(EN_COMPOUNDS_CASE_SENSITIVE)
Additional comments not posted (11)
mkdocs.yml (1)
1-8: LGTM! Verify the existence of referenced Markdown files.The changes to the site name and navigation structure are well-organized and improve the documentation framework.
Ensure that all referenced Markdown files exist in the repository.
Run the following script to verify the existence of the referenced Markdown files:
Verification successful
Let's correct the script to verify the existence of the referenced Markdown files using the correct
fdcommand syntax.
All referenced Markdown files exist.
The navigation structure in
mkdocs.ymlis correctly set up, and all referenced Markdown files are present in the repository.
docs/index.mddocs/overview.mddocs/accessing-data.mddocs/retrospective.mddocs/forecast.mddocs/applications.mdScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of referenced Markdown files in the navigation structure. # Test: Check for the existence of each referenced Markdown file. for file in "index.md" "overview.md" "accessing-data.md" "retrospective.md" "forecast.md" "applications.md"; do if ! fd --type f --name "$file"; then echo "File not found: $file" fi doneLength of output: 2789
Script:
#!/bin/bash # Description: Verify the existence of referenced Markdown files in the navigation structure. # Test: Check for the existence of each referenced Markdown file. for file in "index.md" "overview.md" "accessing-data.md" "retrospective.md" "forecast.md" "applications.md"; do if ! fd --type f "$file"; then echo "File not found: $file" fi doneLength of output: 941
docs/overview.md (4)
1-8: Ensure the image and link are functional.The introduction to GEOGLOWS is clear and informative.
Verify that the image
image3.pngis accessible and the link to the GEOGLOWS website is functional.
10-13: Verify the accessibility of presentation links.The links to presentations are valuable resources.
Ensure that the SharePoint links to the presentations are accessible to the intended audience.
15-18: Verify the accessibility of the history presentation link.The link to the history presentation is appropriate.
Ensure that the SharePoint link to the history presentation is accessible to the intended audience.
20-22: Verify the accessibility of the model formulation presentation link.The link to the model formulation presentation is relevant.
Ensure that the SharePoint link to the model formulation presentation is accessible to the intended audience.
docs/forecast.md (3)
49-51: Verify the functionality of the Colab notebook link.The link to the Colab notebook is practical and useful.
Ensure that the Colab notebook link is functional and accessible.
Tools
LanguageTool
[typographical] ~49-~49: It appears that a comma is missing.
Context: ...mn header “Streamflow (m3/s).” In this example we are following the GEOGloWS ECMWF Str...(DURING_THAT_TIME_COMMA)
Markdownlint
51-51: null
Bare URL used(MD034, no-bare-urls)
54-55: LGTM!The guidance on reorganizing forecast data is clear and informative.
58-58: Ensure the image is functional.The image enhances the content.
Verify that the image
screenshot.pngis accessible and displays correctly.docs/accessing-data.md (3)
40-51: Programmatic Access section looks good.The content is clear and provides useful resources for programmatic access.
59-67: Bulk Data Download section looks good.The content is clear and provides useful resources for downloading data.
69-71: Forecast Data section looks good.The content is clear and provides useful information on accessing forecast data.
docs/overview.md
Outdated
| ## Stories of Application | ||
|
|
||
| The presentation below outlines success stories wherein GEOGloWS resources | ||
| have been employed effectively for the use of those in need. | ||
|
|
||
| [Stories](https://byu.sharepoint.com/:p:/r/sites/BYUHydroinformaticsLaboratory/Shared%20Documents/geoglows-training/GEOGLOWS%20Master%20Training%20Materials/What%20is%20GEOGLOWS/GEOGloWS%20-%20Stories.pptx?d=web302a8f8f774b8caa227fe40c05d4c0&csf=1&web=1&e=kpz1f7) *this still needs to be updated to the correct format* |
There was a problem hiding this comment.
Verify the functionality and update the presentation link.
The link to the application stories presentation is useful, but it needs updating.
Ensure that the SharePoint link to the application stories presentation is functional. Would you like assistance in updating the presentation to the correct format?
docs/accessing-data.md
Outdated
| New 15 day forecasts are produced each day and made available immediately via a [web data service](https://geoglows.ecmwf.int) as well as on an AWS S3 bucket. The CLI command pattern for downloading forecast datasets is: | ||
|
|
||
| ## Retrospective Data | ||
| The retrospective simulation datasets are organized by computational groups (VPUs). Please review the tutorial on [Finding River Numbers](https://data.geoglows.org/tutorials/finding-river-numbers) for help identifying streams and VPU numbers. The CLI command pattern to use for downloading this data is: |
There was a problem hiding this comment.
Correct the grammar issue.
The phrase "for help identifying" should be revised for clarity.
Apply this diff to correct the grammar:
-for help identifying streams and VPU numbers.
+to help identify streams and VPU numbers.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The retrospective simulation datasets are organized by computational groups (VPUs). Please review the tutorial on [Finding River Numbers](https://data.geoglows.org/tutorials/finding-river-numbers) for help identifying streams and VPU numbers. The CLI command pattern to use for downloading this data is: | |
| The retrospective simulation datasets are organized by computational groups (VPUs). Please review the tutorial on [Finding River Numbers](https://data.geoglows.org/tutorials/finding-river-numbers) to help identify streams and VPU numbers. The CLI command pattern to use for downloading this data is: |
Tools
LanguageTool
[grammar] ~73-~73: The verb ‘help’ is used with an infinitive.
Context: ...torials/finding-river-numbers) for help identifying streams and VPU numbers. The CLI comman...(ADVISE_VBG)
There was a problem hiding this comment.
Actionable comments posted: 6
Outside diff range, codebase verification and nitpick comments (11)
docs/forecast.md (2)
45-45: Improve conciseness.Consider removing “of” to be more concise.
Apply this diff to improve conciseness:
-All of the observed data should be in the folder on your Google Drive called +All the observed data should be in the folder on your Google Drive calledTools
LanguageTool
[style] ~45-~45: Consider removing “of” to be more concise
Context: ...our Google Drive in the correct format. All of the observed data should be in the folder o...(ALL_OF_THE)
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...Forecast_Validation/Country/’ (for this example the country is Honduras, so it would be...(AI_HYDRA_LEO_MISSING_COMMA)
51-51: Avoid bare URLs.Consider using a markdown link instead of a bare URL.
Apply this diff to avoid bare URLs:
-The Colab notebook is available here: https://colab.research.google.com/drive/1VMs50wKE55TBn8tWTimc69s1rNaom8SI +The Colab notebook is available [here](https://colab.research.google.com/drive/1VMs50wKE55TBn8tWTimc69s1rNaom8SI)Tools
Markdownlint
51-51: null
Bare URL used(MD034, no-bare-urls)
docs/accessing-data.md (4)
15-15: Remove trailing punctuation in heading.Trailing punctuation in heading is unnecessary.
Apply this diff to remove the trailing punctuation:
-### Features: +### FeaturesTools
Markdownlint
15-15: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
22-22: Remove trailing punctuation in heading.Trailing punctuation in heading is unnecessary.
Apply this diff to remove the trailing punctuation:
-### Benefits: +### BenefitsTools
Markdownlint
22-22: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
29-29: Remove trailing punctuation in heading.Trailing punctuation in heading is unnecessary.
Apply this diff to remove the trailing punctuation:
-### Target Users: +### Target UsersTools
Markdownlint
29-29: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
36-36: Remove trailing punctuation in heading.Trailing punctuation in heading is unnecessary.
Apply this diff to remove the trailing punctuation:
-### Note: +### NoteTools
Markdownlint
36-36: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
docs/overview.md (5)
8-8: Consider alternative adjective.Consider an alternative adjective to strengthen your wording.
Apply this diff to strengthen your wording:
-deeper insights into the scope and impact of GEOGLOWS. +profound insights into the scope and impact of GEOGLOWS.Tools
LanguageTool
[style] ~8-~8: Consider an alternative adjective to strengthen your wording.
Context: ... The presentation linked below provides deeper insights into the scope and impact of G...(DEEP_PROFOUND)
15-15: Consider alternative adjective.Consider an alternative adjective to strengthen your wording.
Apply this diff to strengthen your wording:
-deeper insight into the history and impact of GEOGLOWS. +profound insight into the history and impact of GEOGLOWS.Tools
LanguageTool
[style] ~15-~15: Consider an alternative adjective to strengthen your wording.
Context: ...dness. The presentation below offers a deeper insight into the history and impact of ...(DEEP_PROFOUND)
22-22: Consider alternative adjective.Consider an alternative adjective to strengthen your wording.
Apply this diff to strengthen your wording:
-deeper insight into the model formulation of the GEOGLOWS Model. +profound insight into the model formulation of the GEOGLOWS Model.Tools
LanguageTool
[style] ~22-~22: Consider an alternative adjective to strengthen your wording.
Context: ...aking. The presentation below offers a deeper insight into the model formulation of t...(DEEP_PROFOUND)
31-31: Avoid bare URLs.Consider using a markdown link instead of a bare URL.
Apply this diff to avoid bare URLs:
-The GEOGloWS ECMWF Streamflow Model can be easily explored using a mapping service developed in collaboration with Esri (see: https://hydroviewer.geoglows.org/). +The GEOGloWS ECMWF Streamflow Model can be easily explored using a mapping service developed in collaboration with Esri (see: [hydroviewer.geoglows.org](https://hydroviewer.geoglows.org/)).Tools
Markdownlint
31-31: null
Bare URL used(MD034, no-bare-urls)
57-58: Fix unordered list indentation.Unordered list indentation is inconsistent.
Apply this diff to fix the unordered list indentation:
- * [English Survey](https://forms.gle/eZr1nARB5L2kvMGy9) - * [Español Survey](https://forms.gle/gjUedjP74PVb368w5) +* [English Survey](https://forms.gle/eZr1nARB5L2kvMGy9) +* [Español Survey](https://forms.gle/gjUedjP74PVb368w5)Tools
Markdownlint
57-57: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
58-58: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (4)
docs/image7.pngis excluded by!**/*.pngdocs/images/img6.pngis excluded by!**/*.pngdocs/img8.pngis excluded by!**/*.pngdocs/img9.pngis excluded by!**/*.png
Files selected for processing (5)
- docs/accessing-data.md (1 hunks)
- docs/forecast.md (1 hunks)
- docs/index.md (1 hunks)
- docs/overview.md (1 hunks)
- docs/retrospective.md (1 hunks)
Files skipped from review due to trivial changes (1)
- docs/index.md
Additional context used
LanguageTool
docs/forecast.md
[uncategorized] ~12-~12: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...validate the GEOGloWS ECMWF Streamflow Services short-term forecast in any flood event...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[style] ~45-~45: Consider removing “of” to be more concise
Context: ...our Google Drive in the correct format. All of the observed data should be in the folder o...(ALL_OF_THE)
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...Forecast_Validation/Country/’ (for this example the country is Honduras, so it would be...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~49-~49: It appears that a comma is missing.
Context: ...mn header “Streamflow (m3/s).” In this example we are following the GEOGloWS ECMWF Str...(DURING_THAT_TIME_COMMA)
docs/accessing-data.md
[grammar] ~73-~73: The verb ‘help’ is used with an infinitive.
Context: ...torials/finding-river-numbers) for help identifying streams and VPU numbers. The CLI comman...(ADVISE_VBG)
docs/overview.md
[style] ~8-~8: Consider an alternative adjective to strengthen your wording.
Context: ... The presentation linked below provides deeper insights into the scope and impact of G...(DEEP_PROFOUND)
[style] ~15-~15: Consider an alternative adjective to strengthen your wording.
Context: ...dness. The presentation below offers a deeper insight into the history and impact of ...(DEEP_PROFOUND)
[style] ~22-~22: Consider an alternative adjective to strengthen your wording.
Context: ...aking. The presentation below offers a deeper insight into the model formulation of t...(DEEP_PROFOUND)
docs/retrospective.md
[grammar] ~33-~33: Did you mean “are” or “were”?
Context: ...n results to observed data. Hydrostats is an open-source software package designe...(SENT_START_NNS_IS)
[misspelling] ~49-~49: This word is normally spelled with a hyphen.
Context: ...ats App 3. Login with the Demo Account (case sensitive) * Username: demo * Password: demo ## ...(EN_COMPOUNDS_CASE_SENSITIVE)
Markdownlint
docs/forecast.md
51-51: null
Bare URL used(MD034, no-bare-urls)
docs/accessing-data.md
15-15: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
22-22: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
29-29: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
36-36: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
docs/overview.md
57-57: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
58-58: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
31-31: null
Bare URL used(MD034, no-bare-urls)
docs/retrospective.md
62-62: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
40-40: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
47-47: null
Bare URL used(MD034, no-bare-urls)
106-106: Duplicate link or image reference definition: "1"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
Additional comments not posted (17)
docs/forecast.md (5)
1-2: LGTM!The introduction to forecast data is clear and well-formatted.
The code changes are approved.
29-38: LGTM!The instructions for getting the forecast record are clear and well-structured.
The code changes are approved.
43-49: LGTM!The instructions for comparing observed data with forecasts are clear and well-structured.
The code changes are approved.
Tools
LanguageTool
[style] ~45-~45: Consider removing “of” to be more concise
Context: ...our Google Drive in the correct format. All of the observed data should be in the folder o...(ALL_OF_THE)
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...Forecast_Validation/Country/’ (for this example the country is Honduras, so it would be...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~49-~49: It appears that a comma is missing.
Context: ...mn header “Streamflow (m3/s).” In this example we are following the GEOGloWS ECMWF Str...(DURING_THAT_TIME_COMMA)
53-55: LGTM!The instructions for reorganizing the forecast data are clear and well-structured.
The code changes are approved.
57-60: LGTM!The instructions for comparing days-in-advance forecasts with observed data are clear and well-structured.
The code changes are approved.
docs/accessing-data.md (5)
1-2: LGTM!The introduction to accessing data is clear and well-formatted.
The code changes are approved.
40-56: LGTM!The instructions for programmatic access to data are clear and well-structured.
The code changes are approved.
59-75: LGTM!The instructions for bulk data download are clear and well-structured.
The code changes are approved.
Tools
LanguageTool
[grammar] ~73-~73: The verb ‘help’ is used with an infinitive.
Context: ...torials/finding-river-numbers) for help identifying streams and VPU numbers. The CLI comman...(ADVISE_VBG)
72-73: Correct the grammar issue.The phrase "for help identifying" should be revised for clarity.
Apply this diff to correct the grammar:
-for help identifying streams and VPU numbers. +to help identify streams and VPU numbers.Tools
LanguageTool
[grammar] ~73-~73: The verb ‘help’ is used with an infinitive.
Context: ...torials/finding-river-numbers) for help identifying streams and VPU numbers. The CLI comman...(ADVISE_VBG)
69-70: LGTM!The instructions for forecast data are clear and well-structured.
The code changes are approved.
docs/overview.md (2)
1-2: LGTM!The introduction to GEOGLOWS is clear and well-formatted.
The code changes are approved.
43-48: Verify the functionality and update the presentation link.The link to the application stories presentation is useful, but it needs updating.
Ensure that the SharePoint link to the application stories presentation is functional. Would you like assistance in updating the presentation to the correct format?
docs/retrospective.md (5)
3-10: LGTM!The section is clear and provides useful resources.
The code changes are approved.
17-27: Fix grammar issue and bare URL.The section is informative but needs minor corrections.
Apply this diff to fix the grammar issue:
-Results do not need to be perfect, but they need to be reliable and accurate enough to give decision-makers the confidence to use them. The model accuracy is typically evaluated by comparing simulation results to observed data. +Results do not need to be perfect, but they need to be reliable and accurate enough to give decision-makers the confidence to use them. The model accuracy is typically evaluated by comparing simulation results to observed data.Apply this diff to fix the bare URL:
-1. Use this link to download the demo historical observed data: https://www.hydroshare.org/resource/d222676fbd984a81911761ca1ba936bf/data/contents/Discharge_Data/23187280.csv If you are performing the validation using your own observed data, your data must have two columns with column headers in the first row. The first column should be titled ‘datetime’ and contain dates in a standard format. The other may have any title but must contain streamflow values in cubic meters per second (m^3/s). The observed data csv should look like this: +1. Use this link to download the demo historical observed data: [Demo Historical Observed Data](https://www.hydroshare.org/resource/d222676fbd984a81911761ca1ba936bf/data/contents/Discharge_Data/23187280.csv) If you are performing the validation using your own observed data, your data must have two columns with column headers in the first row. The first column should be titled ‘datetime’ and contain dates in a standard format. The other may have any title but must contain streamflow values in cubic meters per second (m^3/s). The observed data csv should look like this:
37-43: Fix bare URL.The section is clear but needs minor corrections.
Apply this diff to fix the bare URL:
-2. To get the historical simulation data, go to this url, which will access the API and download the historical simulation: https://geoglows.ecmwf.int/api/HistoricSimulation/?reach_id=9004355&return_format=csv This may take a few minutes. If you are performing the validation for a different Reach ID, you may edit the Reach ID in the url above, or use the GEOGloWS website to access the API. To use the interactive website, go to this link: https://geoglows.ecmwf.int/documentation and click Get Historic Simulation. Click “Try,” enter the Reach ID, and click “execute.” This will then give you the option to download the historical simulation. The simulated data csv should look like this: +2. To get the historical simulation data, go to this url, which will access the API and download the historical simulation: [Historical Simulation Data](https://geoglows.ecmwf.int/api/HistoricSimulation/?reach_id=9004355&return_format=csv) This may take a few minutes. If you are performing the validation for a different Reach ID, you may edit the Reach ID in the url above, or use the GEOGloWS website to access the API. To use the interactive website, go to this link: [GEOGloWS Documentation](https://geoglows.ecmwf.int/documentation) and click Get Historic Simulation. Click “Try,” enter the Reach ID, and click “execute.” This will then give you the option to download the historical simulation. The simulated data csv should look like this:Tools
Markdownlint
40-40: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
44-51: Fix spelling issue and bare URL.The section is clear but needs minor corrections.
Apply this diff to fix the spelling issue:
-3. Login with the Demo Account (case sensitive) +3. Log in with the Demo Account (case-sensitive)Apply this diff to fix the bare URL:
-1. Go to http://apps.geoglows.org/apps/ +1. Go to [GEOGloWS Apps](http://apps.geoglows.org/apps/)Tools
LanguageTool
[misspelling] ~49-~49: This word is normally spelled with a hyphen.
Context: ...ats App 3. Login with the Demo Account (case sensitive) * Username: demo * Password: demo ## ...(EN_COMPOUNDS_CASE_SENSITIVE)
Markdownlint
47-47: null
Bare URL used(MD034, no-bare-urls)
62-107: Fix heading level issue and bare URL.The section is informative but needs minor corrections.
Apply this diff to fix the heading level issue:
-#### Introduction +### IntroductionApply this diff to fix the bare URL:
> The [Google Colab notebook][2] outlines the steps to run the bias correction method in python, using the geoglows package.Tools
Markdownlint
62-62: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
106-106: Duplicate link or image reference definition: "1"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
| This part of the workshop will show you how to validate the | ||
| GEOGloWS ECMWF Streamflow Services short-term forecast in any | ||
| flood event in any place in the world. You will compare observed | ||
| data with simulated forecasts for a flood event to see how well | ||
| the forecast performs. |
There was a problem hiding this comment.
Correct the grammatical issue.
It seems likely that a singular genitive (’s) apostrophe is missing in "GEOGloWS ECMWF Streamflow Services short-term forecast".
Apply this diff to correct the grammatical issue:
-validate the GEOGloWS ECMWF Streamflow Services short-term forecast in any flood event
+validate the GEOGloWS ECMWF Streamflow Services' short-term forecast in any flood eventCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| This part of the workshop will show you how to validate the | |
| GEOGloWS ECMWF Streamflow Services short-term forecast in any | |
| flood event in any place in the world. You will compare observed | |
| data with simulated forecasts for a flood event to see how well | |
| the forecast performs. | |
| This part of the workshop will show you how to validate the | |
| GEOGloWS ECMWF Streamflow Services' short-term forecast in any | |
| flood event in any place in the world. You will compare observed | |
| data with simulated forecasts for a flood event to see how well | |
| the forecast performs. |
Tools
LanguageTool
[uncategorized] ~12-~12: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...validate the GEOGloWS ECMWF Streamflow Services short-term forecast in any flood event...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
|
|
||
| The observed data files should be in the same format as the example file below. The left column should contain the datetime (format: yyyy-mm-dd hh:mm:ss) with the column header “Datetime.” The right column should contain streamflow with units of m3/s and the column header “Streamflow (m3/s).” | ||
|
|
||
| In this example we are following the GEOGloWS ECMWF Streamflow Services (GESS) Forecast Validation for the Eta and Iota Hurricanes in the stations HDRPV-Jicaro (951603) and HDRPV-Maragua (951795) in Honduras. The data needed for the example is available here: |
There was a problem hiding this comment.
Add missing comma.
A comma is missing after "In this example".
Apply this diff to add the missing comma:
-In this example we are following the GEOGloWS ECMWF Streamflow Services
+In this example, we are following the GEOGloWS ECMWF Streamflow ServicesCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| In this example we are following the GEOGloWS ECMWF Streamflow Services (GESS) Forecast Validation for the Eta and Iota Hurricanes in the stations HDRPV-Jicaro (951603) and HDRPV-Maragua (951795) in Honduras. The data needed for the example is available here: | |
| In this example, we are following the GEOGloWS ECMWF Streamflow Services (GESS) Forecast Validation for the Eta and Iota Hurricanes in the stations HDRPV-Jicaro (951603) and HDRPV-Maragua (951795) in Honduras. The data needed for the example is available here: |
Tools
LanguageTool
[typographical] ~49-~49: It appears that a comma is missing.
Context: ...mn header “Streamflow (m3/s).” In this example we are following the GEOGloWS ECMWF Str...(DURING_THAT_TIME_COMMA)
|
|
||
| ## Step 2: Compare Observed Data with Forecasts | ||
|
|
||
| The second step in validating the performance of the GESS forecast during flood events is comparing the observed values with the original forecast datasets. First, you will need to save the observed streamflow data for the high flow event of interest to your Google Drive in the correct format. All of the observed data should be in the folder on your Google Drive called ‘Forecast_Validation/Country/’ (for this example the country is Honduras, so it would be ‘Forecast_Validation/Honduras/’). The observed data file for each station should be named in this format: ‘{station name}_RT_Q_orig.csv’ |
There was a problem hiding this comment.
Add missing comma.
A comma is missing after "for this example".
Apply this diff to add the missing comma:
-(for this example the country is Honduras, so it would be
+(for this example, the country is Honduras, so it would beCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The second step in validating the performance of the GESS forecast during flood events is comparing the observed values with the original forecast datasets. First, you will need to save the observed streamflow data for the high flow event of interest to your Google Drive in the correct format. All of the observed data should be in the folder on your Google Drive called ‘Forecast_Validation/Country/’ (for this example the country is Honduras, so it would be ‘Forecast_Validation/Honduras/’). The observed data file for each station should be named in this format: ‘{station name}_RT_Q_orig.csv’ | |
| The second step in validating the performance of the GESS forecast during flood events is comparing the observed values with the original forecast datasets. First, you will need to save the observed streamflow data for the high flow event of interest to your Google Drive in the correct format. All of the observed data should be in the folder on your Google Drive called ‘Forecast_Validation/Country/’ (for this example, the country is Honduras, so it would be ‘Forecast_Validation/Honduras/’). The observed data file for each station should be named in this format: ‘{station name}_RT_Q_orig.csv’ |
Tools
LanguageTool
[style] ~45-~45: Consider removing “of” to be more concise
Context: ...our Google Drive in the correct format. All of the observed data should be in the folder o...(ALL_OF_THE)
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...Forecast_Validation/Country/’ (for this example the country is Honduras, so it would be...(AI_HYDRA_LEO_MISSING_COMMA)
| This tutorial will guide you through the process of retrieving and manipulating retrospective simulation results for a specific river using the GEOGLOWS Hydrological Model. | ||
|
|
||
| [Retrospective Colab Notebook](https://colab.research.google.com/drive/1DEqWPDbIgs21N-Q4AOQC4bAdZN1PQt54#scrollTo=kN_2TS4gbTZl) | ||
| ## Return Periods & Daily Data |
There was a problem hiding this comment.
Add content for the section.
The section title is present but lacks content.
Please add the necessary content for this section.
| * Username: demo | ||
| * Password: demo | ||
|
|
||
| ## Preprocessing |
There was a problem hiding this comment.
Add content for the section.
The section title is present but lacks content.
Please add the necessary content for this section.
docs/retrospective.md
Outdated
|
|
||
| [1]: https://byu.sharepoint.com/:p:/r/sites/BYUHydroinformaticsLaboratory/Shared%20Documents/geoglows-training/GEOGLOWS%20Master%20Training%20Materials/Retrospective%20Validation/GEOGloWS%20-%20BiasCorrection.pptx?d=w84cc417ccfae43f5bae9222655db3728&csf=1&web=1&e=5PBsfY | ||
| [2]: https://colab.research.google.com/drive/15MUTx3lb5P93BLUv8Uehv0gTudc43qkX?usp=sharing | ||
| ## SABER |
There was a problem hiding this comment.
Add content for the section.
The section title is present but lacks content.
Please add the necessary content for this section.
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range and nitpick comments (17)
docs/index.md (2)
1-4: Consider using a more descriptive image file name.The image file name "image3.png" is generic. Using a more descriptive name would improve maintainability and provide context about the image content.
Consider renaming the image file to something more descriptive, such as "geoglows_logo.png" or "training_overview.png", depending on the image content.
5-8: Consider adding version or last update information.The overview provides valuable information about GEOGLOWS and its hydrologic model. To enhance clarity and help users understand the currency of the information, consider adding the version number or last update date of the described model.
You could add a sentence like: "As of [month year], the current version of the GEOGLOWS model is [version number]." This would help users understand how up-to-date the information is.
docs/accessing-data.md (2)
45-45: Improve formatting of the last line.The last line appears to be separated from the rest of the content, which may affect readability.
Consider applying this diff to improve the formatting:
- -Go to data.geoglows.org to for instructions. +Go to data.geoglows.org for instructions.This change removes the unnecessary newline and integrates the instruction with the rest of the content.
1-45: Excellent documentation with room for minor enhancements.This document provides comprehensive and well-structured guidance on accessing GEOGLOWS data through various methods. The inclusion of visual aids and external resources greatly enhances the user experience. To further improve the document:
- Consider adding a brief introduction or overview at the beginning to set the context for the different access methods.
- You might want to include a table of contents for easier navigation, especially as the document grows.
Here's a suggested structure for the introduction:
# Accessing Data This guide outlines various methods for accessing GEOGLOWS data: 1. [Hydroviewer App](#hydroviewer-app): A web-based tool for visualizing and interacting with streamflow data. 2. [Programmatic Access](#programmatic-access): Accessing data via API and Python package. 3. [Bulk Data Download](#bulk-data-download): Methods for downloading large datasets. Choose the method that best suits your needs and technical expertise. ## Hydroviewer App ...This introduction provides a quick overview and helps users navigate to the relevant sections.
docs/overview.md (7)
3-3: Consider adding a caption to the image.The image enhances the visual appeal of the document, but its specific relevance to GEOGLOWS is not immediately clear. Adding a brief caption would provide context and improve the reader's understanding.
10-10: Enhance the link description for better context.The link to the GEOGLOWS V2 Overview presentation is valuable, but it could benefit from a more descriptive text. Consider revising it to something like:
[GEOGLOWS V2 Overview Presentation: Scope and Impact](https://drive.google.com/file/d/1h9skkuJQ-LR301nXSHjYRNHnso07gtac/view?usp=sharing)This change would give readers a clearer idea of what to expect when clicking the link.
17-17: Enhance the link description for the history presentation.Similar to the previous suggestion, consider revising the link text to provide more context:
[GEOGLOWS History: Evolution and Impact Presentation](https://drive.google.com/file/d/1dICEwFCFEIWnYgVAUNlrqsUMj487yp4o/view?usp=sharing)This change would give readers a clearer idea of the presentation's content.
24-24: Enhance the link description for the model formulation presentation.To maintain consistency and provide more context, consider revising the link text:
[GEOGLOWS Model Formulation: Technical Details Presentation](https://drive.google.com/file/d/1thabA0RBfSVYAIcKkgMOBFSZwhtmxvv2/view?usp=sharing)This change would give readers a clearer idea of the presentation's content and maintain consistency with the previous links.
26-42: Improve formatting and add captions to images.
- Consider using second-level headings (##) for the main section and third-level headings (###) for subsections to improve the document structure:
## Understanding GEOGLOWS Data ### Hydrofabric ### Map ### Retrospective Data ### Forecasts
- Add captions to the images to provide context:
 *Figure 1: GEOGLOWS Streamflow Visualization Map showing discharge magnitude and return periods.*  *Figure 2: Example of GEOGLOWS retrospective data visualization.*  *Figure 3: GEOGLOWS forecast simulation plot showing median, 20th, and 80th percentiles.*These changes will improve the document's structure and provide better context for the images.
Tools
Markdownlint
32-32: null
Bare URL used(MD034, no-bare-urls)
49-49: Enhance the link description for the application stories presentation.To maintain consistency and provide more context, consider revising the link text:
[GEOGLOWS Application Success Stories Presentation](https://drive.google.com/file/d/1-CbslVlrtOyobNkR18uusWVdjqp0OsuW/view?usp=sharing)This change would give readers a clearer idea of the presentation's content and maintain consistency with the previous links.
58-59: Improve formatting of survey links.To maintain consistency with the document's formatting and improve readability, consider using a bulleted list for the survey links:
If you are a GEOGLOWS User, please take our survey: * [English Survey](https://forms.gle/eZr1nARB5L2kvMGy9) * [Español Survey](https://forms.gle/gjUedjP74PVb368w5)This change will align the formatting with the rest of the document and make the survey options more visually distinct.
Tools
Markdownlint
58-58: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
59-59: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
docs/retrospective.md (6)
1-11: Consider improving resource accessibility and image display.
The SharePoint link to the presentation might not be accessible to all users. Consider hosting the presentation on a more publicly accessible platform or providing alternative access methods.
The image reference
may not display correctly if the image file is not in the correct location relative to this Markdown file. Ensure that the image file is properly placed and consider using a more descriptive name for the image.
16-37: Improve structure and content of the Historical Validation section.Consider the following improvements:
- Add subheadings to break down the content into more manageable chunks.
- Provide a brief explanation of what historical validation is before diving into the workshops.
- Consider adding a brief description of what users can expect to learn from the Google Colab notebook.
Tools
LanguageTool
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...TESSEL model. After that, the runoff is resampled performing an area-weighted grid-to-vec...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~33-~33: Did you mean “are” or “were”?
Context: ...n results to observed data. Hydrostats is an open-source software package designe...(SENT_START_NNS_IS)
37-44: Improve URL formatting and section presentation.
- Convert bare URLs to proper Markdown links for better readability. For example:
[download the demo historical observed data](https://www.hydroshare.org/resource/d222676fbd984a81911761ca1ba936bf/data/contents/Discharge_Data/23187280.csv)
Consider using a numbered or bulleted list for the steps to improve readability.
Add a brief explanation of what a Reach ID is and how to obtain it for those who might be new to the system.
Tools
Markdownlint
40-40: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
61-89: Improve formatting and address the need for more explanation in the Bias Correction section.
Consider using Markdown formatting to improve readability:
- Use
##for the "Bias Correction" heading to maintain consistency with other main sections.- Use
###for the "Introduction" subheading.- Consider using blockquotes (
>) for the definition or key points about bias correction.The comment
<!--this needs more explanation-->indicates that more detail is required. Identify specific areas that need elaboration and add the necessary information.If there are specific examples or case studies of bias correction in action, consider adding them to illustrate the concept more concretely.
Tools
Markdownlint
62-62: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
90-107: Improve resource presentation and address comments.
Format the links to the presentation and Google Colab notebook as proper Markdown links for better readability.
The image reference
[![image(https://training.geoglows.org/en/latest/_images/forecasts.png)]]is incorrectly formatted. Correct it to:Implement the suggestion to create a link to the Hydroviewer tutorial. Add a sentence like:
"For more information on using the Hydroviewer, please refer to our Hydroviewer Tutorial."Regarding the AI-generated content, consider being more specific about which parts were AI-generated and how they were reviewed or validated by human experts.
Tools
Markdownlint
106-106: Duplicate link or image reference definition: "1"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
1-107: Overall document review and suggestions for improvement.This document provides a comprehensive overview of retrospective data analysis for the GEOGloWS Hydrological Model. However, there are several areas that need attention to make it more effective:
- Fill in the empty sections: "Return Periods & Daily Data", "Preprocessing", and "Visualization".
- Improve the overall structure by ensuring consistent heading levels and logical flow between sections.
- Address potential security issues, particularly regarding the display of login credentials.
- Enhance accessibility by ensuring all external resources (presentations, notebooks) are easily accessible to all users.
- Improve formatting throughout the document, particularly for links and code blocks.
- Provide more concrete examples or case studies to illustrate key concepts, especially in the Bias Correction section.
- Ensure all images are correctly referenced and displayed.
- Implement internal links to related sections or tutorials (e.g., Hydroviewer) for better navigation.
Consider having subject matter experts review the content for accuracy and completeness, especially for the sections that were partially generated by AI.
Tools
LanguageTool
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...TESSEL model. After that, the runoff is resampled performing an area-weighted grid-to-vec...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~33-~33: Did you mean “are” or “were”?
Context: ...n results to observed data. Hydrostats is an open-source software package designe...(SENT_START_NNS_IS)
[misspelling] ~49-~49: This word is normally spelled with a hyphen.
Context: ...ats App 3. Login with the Demo Account (case sensitive) * Username: demo * Password: demo ## ...(EN_COMPOUNDS_CASE_SENSITIVE)
Markdownlint
62-62: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
40-40: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
47-47: null
Bare URL used(MD034, no-bare-urls)
106-106: Duplicate link or image reference definition: "1"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- docs/accessing-data.md (1 hunks)
- docs/index.md (1 hunks)
- docs/overview.md (1 hunks)
- docs/retrospective.md (1 hunks)
Additional context used
LanguageTool
docs/overview.md
[style] ~8-~8: Consider an alternative adjective to strengthen your wording.
Context: ... The presentation linked below provides deeper insights into the scope and impact of G...(DEEP_PROFOUND)
[style] ~15-~15: Consider an alternative adjective to strengthen your wording.
Context: ...dness. The presentation below offers a deeper insight into the history and impact of ...(DEEP_PROFOUND)
[style] ~22-~22: Consider an alternative adjective to strengthen your wording.
Context: ...aking. The presentation below offers a deeper insight into the model formulation of t...(DEEP_PROFOUND)
docs/retrospective.md
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...TESSEL model. After that, the runoff is resampled performing an area-weighted grid-to-vec...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~33-~33: Did you mean “are” or “were”?
Context: ...n results to observed data. Hydrostats is an open-source software package designe...(SENT_START_NNS_IS)
[misspelling] ~49-~49: This word is normally spelled with a hyphen.
Context: ...ats App 3. Login with the Demo Account (case sensitive) * Username: demo * Password: demo ## ...(EN_COMPOUNDS_CASE_SENSITIVE)
Markdownlint
docs/overview.md
58-58: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
59-59: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
32-32: null
Bare URL used(MD034, no-bare-urls)
docs/retrospective.md
62-62: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
40-40: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
47-47: null
Bare URL used(MD034, no-bare-urls)
106-106: Duplicate link or image reference definition: "1"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
Additional comments not posted (9)
docs/index.md (2)
12-18: Well-structured website sections list.The list of website sections is clear, concise, and well-formatted. It provides a good overview of the website's structure, making it easy for users to understand the available content.
1-31: Excellent introduction to the GEOGLOWS training website.This index.md file serves as a well-structured and informative introduction to the GEOGLOWS training website. It effectively communicates the purpose of GEOGLOWS, outlines the website structure, and provides helpful navigation guidance for users with different levels of familiarity with the program.
The content is generally clear and concise, making it easy for users to understand how to navigate the resources available. With a few minor adjustments as suggested in the previous comments, this file will provide an even stronger foundation for users engaging with the GEOGLOWS training materials.
docs/accessing-data.md (3)
3-13: LGTM! Well-structured introduction to the Hydroviewer App.The section provides a clear introduction to the Hydroviewer App, its purpose, and includes helpful visual aid and a link to a detailed tutorial. This approach effectively guides users to understand and utilize the tool.
16-32: LGTM! Comprehensive guide for programmatic access.This section effectively outlines the methods for programmatically accessing GEOGLOWS data. The inclusion of visual aids, external resources (presentation and Google Colab notebook), and the use of reference-style links contribute to a well-structured and informative guide.
35-45: LGTM! Clear instructions for bulk data download.This section effectively outlines the methods for bulk data download, including both AWS and web browser options. The inclusion of visual aids and links to external resources (Colab Notebook and Available Data page) provides users with comprehensive guidance.
docs/overview.md (1)
1-59: Overall, excellent introduction to GEOGLOWS with minor improvements suggested.This document provides a comprehensive and well-structured overview of GEOGLOWS. The content is informative and covers key aspects of the initiative, including its purpose, history, model formulation, data understanding, and user engagement.
To further enhance the document:
- Consider adding a table of contents at the beginning for easier navigation.
- Ensure consistent formatting throughout, especially for headings and subheadings.
- Review all external links to ensure they are up-to-date and functional.
- Consider adding a brief conclusion or summary section at the end.
These minor improvements will make the document even more user-friendly and informative for readers interested in GEOGLOWS.
Tools
LanguageTool
[style] ~8-~8: Consider an alternative adjective to strengthen your wording.
Context: ... The presentation linked below provides deeper insights into the scope and impact of G...(DEEP_PROFOUND)
[style] ~15-~15: Consider an alternative adjective to strengthen your wording.
Context: ...dness. The presentation below offers a deeper insight into the history and impact of ...(DEEP_PROFOUND)
[style] ~22-~22: Consider an alternative adjective to strengthen your wording.
Context: ...aking. The presentation below offers a deeper insight into the model formulation of t...(DEEP_PROFOUND)
Markdownlint
58-58: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
59-59: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
32-32: null
Bare URL used(MD034, no-bare-urls)
docs/retrospective.md (3)
15-15: Add content for the "Return Periods & Daily Data" section.This section title is present but lacks content. Please add the necessary information about return periods and daily data, or consider removing the section if it's not needed.
53-53: Add content for the "Preprocessing" section.The "Preprocessing" section title is present but lacks content. Please add the necessary information about data preprocessing steps, or consider removing the section if it's not needed at this point in the document.
55-55: Add content for the "Visualization" section.The "Visualization" section title is present but lacks content. Please add information about visualization techniques or tools used in the context of retrospective data analysis, or consider removing the section if it's not needed.
docs/index.md
Outdated
| Each of these sections includes text, presentations, and Google Colab | ||
| notebooks with information to help the user navigate GEOGLOWS on his/her own. | ||
|
|
||
| If you are new to GEOGLOWS, start with the **Overview** section to gain a | ||
| foundational understanding of the organization. Then move to **Accessing Data** | ||
| to learn how to retrieve and use the data that GEOGLOWS offers. | ||
|
|
||
| If you are looking to understand where the Retrospective and Forecast | ||
| data come from, start in the **Retrospective Data** or **Forecast Data** | ||
| sections, respectively. And to see the impact and possible applications | ||
| of GEOGLOWS data, see the "Stories" in the **Overview** section or the | ||
| **Applications** section. |
There was a problem hiding this comment.
Clarify the reference to "Stories" in the navigation instructions.
The navigation instructions are generally clear and helpful. However, there's an inconsistency in the last paragraph where "Stories" are mentioned as part of the Overview section. This wasn't listed in the website sections earlier, which might confuse users.
Consider one of the following options to address this:
- If "Stories" is a subsection of the Overview, update the website sections list to reflect this structure.
- If "Stories" is meant to be a separate main section, add it to the website sections list.
- If "Stories" is not a formal section, rephrase this part to avoid confusion, e.g., "To see the impact and possible applications of GEOGLOWS data, check the case studies in the Overview section or explore the Applications section."
docs/accessing-data.md
Outdated
|
|
||
| Most GEOGLOWS data can be downloaded from the web browser. Links to these datasets are given at the [Available Data](https://data.geoglows.org/available-data) page. | ||
|
|
||
| Go to data.geoglows.org to for instructions. |
There was a problem hiding this comment.
Fix grammatical error in the last line.
There's a minor grammatical issue in the last line of the document.
Apply this diff to correct the grammar:
-Go to data.geoglows.org to for instructions.
+Go to data.geoglows.org for instructions.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Go to data.geoglows.org to for instructions. | |
| Go to data.geoglows.org for instructions. |
docs/overview.md
Outdated
|
|
||
| ## Stories of Application | ||
|
|
||
| The presentation below outlines success stories wherein GEOGLOWS resources |
There was a problem hiding this comment.
Correct the typo in "wherein".
There's a typo in the word "wherein". Please correct it:
-The presentation below outlines success stories wherein GEOGLOWS resources
+The presentation below outlines success stories where GEOGLOWS resourcesCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The presentation below outlines success stories wherein GEOGLOWS resources | |
| The presentation below outlines success stories where GEOGLOWS resources |
| <!--the presentation linked here was no longer found!--> | ||
|
|
There was a problem hiding this comment.
Resolve or remove the comment about the missing presentation.
The comment <!--the presentation linked here was no longer found!--> indicates a missing resource. Either find and add the correct link to the presentation, or remove this comment and any related text if the presentation is no longer relevant.
| 3. Login with the Demo Account (case sensitive) | ||
| * Username: demo | ||
| * Password: demo |
There was a problem hiding this comment.
Remove or secure login credentials.
Providing login credentials (even for a demo account) in a public document is a security risk. Consider one of the following options:
- Remove the credentials and instruct users to contact an administrator for access.
- Use environment variables or a secure method to provide credentials.
- If this is truly a public demo account, clearly state that it's for demonstration purposes only and that users should not input any sensitive information.
Tools
LanguageTool
[misspelling] ~49-~49: This word is normally spelled with a hyphen.
Context: ...ats App 3. Login with the Demo Account (case sensitive) * Username: demo * Password: demo ## ...(EN_COMPOUNDS_CASE_SENSITIVE)
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Outside diff range and nitpick comments (2)
mkdocs.yml (1)
25-30: LGTM! Consider expanding the navigation structure.The current navigation structure provides a good foundation for the GEOGLOWS training website. It covers the essential topics mentioned in the PR summary.
To further enhance the user experience, consider:
- Adding subsections to provide more detailed navigation. For example:
nav: - Home: index.md - Overview: overview.md - Accessing Data: - Introduction: accessing-data/index.md - Hydrofabric: accessing-data/hydrofabric.md - Hydroviewer App: accessing-data/hydroviewer-app.md - API Access: accessing-data/api-access.md - Bulk Downloads: accessing-data/bulk-downloads.md - Retrospective: retrospective.md - Forecast: forecast.md
- Including additional sections that might be relevant, such as:
- Tutorials or Workshops
- FAQ
- Glossary
- Resources or References
These suggestions can help users navigate the content more easily and provide a more comprehensive training experience.
docs/overview.md (1)
22-22: Consider varying word choice for improved style.The static analysis tool suggests using alternative adjectives to strengthen your wording. Consider varying the phrase "deeper insight" in the following lines:
- Line 22: "The presentation linked below provides deeper insights"
- Line 49: "The presentation below offers a deeper insight"
- Line 57: "The presentation below offers a deeper insight"
You could use alternatives like "comprehensive overview", "in-depth analysis", or "detailed exploration" to add variety to the document.
Also applies to: 49-49, 57-57
🧰 Tools
🪛 LanguageTool
[style] ~22-~22: Consider an alternative adjective to strengthen your wording.
Context: ... The presentation linked below provides deeper insights into the scope and impact of ...(DEEP_PROFOUND)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (1)
docs/img10.pngis excluded by!**/*.png
📒 Files selected for processing (4)
- docs/accessing-data.md (1 hunks)
- docs/index.md (1 hunks)
- docs/overview.md (1 hunks)
- mkdocs.yml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/index.md
🧰 Additional context used
🪛 LanguageTool
docs/overview.md
[style] ~22-~22: Consider an alternative adjective to strengthen your wording.
Context: ... The presentation linked below provides deeper insights into the scope and impact of ...(DEEP_PROFOUND)
[style] ~49-~49: Consider an alternative adjective to strengthen your wording.
Context: ...dness. The presentation below offers a deeper insight into the history and impact of...(DEEP_PROFOUND)
[style] ~57-~57: Consider an alternative adjective to strengthen your wording.
Context: ...aking. The presentation below offers a deeper insight into the model formulation of t...(DEEP_PROFOUND)
🪛 Markdownlint
docs/overview.md
65-65: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
86-86: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
99-99: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
107-107: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
144-144: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
145-145: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
88-88: null
Bare URL used(MD034, no-bare-urls)
🔇 Additional comments (15)
mkdocs.yml (1)
3-22: LGTM! Consider verifying color contrast for accessibility.The theme configuration looks good. The Material theme is an excellent choice, and the color palette is well-defined for both light and dark modes. The indigo color scheme is appropriate for a water-related website.
To ensure accessibility, it's recommended to verify the color contrast ratios. You can use online tools like WebAIM's Contrast Checker (https://webaim.org/resources/contrastchecker/) to confirm that the text colors have sufficient contrast against the background colors in both light and dark modes.
docs/accessing-data.md (4)
1-25: LGTM: Well-structured and informative Hydrofabric sectionThe title and Hydrofabric section are well-written, providing a comprehensive explanation of the GEOGLOWS Hydrofabric's role and importance. The content is informative, and the link to the presentation is correctly formatted.
46-62: LGTM: Comprehensive Programmatic Access sectionThe Programmatic Access section is well-structured and informative. It provides clear instructions and resources for accessing GEOGLOWS data programmatically, including:
- A link to the API documentation
- An informative image
- A presentation on using the web browser interface and the geoglows Python package
- A Google Colab notebook with code examples
The use of reference-style links improves the readability of the Markdown source. Good job!
65-73: LGTM: Informative Bulk Data Download sectionThe Bulk Data Download section effectively covers different methods for accessing large amounts of GEOGLOWS data:
- Downloading data from AWS using a provided Colab Notebook
- Accessing datasets through a web browser
The inclusion of an image and a link to the Colab Notebook for forecast data enhances the usefulness of this section. Good job on providing clear and concise information!
75-75: Fix grammatical error in the last lineThere's a minor grammatical issue in the last line of the document that was previously identified but not addressed.
Apply this diff to correct the grammar:
-Go to [data.geoglows.org](data.geoglows.org) for instructions. +Go to [data.geoglows.org](https://data.geoglows.org) for instructions.This change removes the redundant "to" and adds the "https://" prefix to the URL for proper linking.
docs/overview.md (10)
62-62: Verify the accessibility of the external link.Please check if the link to the Understanding GEOGLOWS Data presentation is accessible and up-to-date.
#!/bin/bash # Check if the link is accessible url="https://drive.google.com/file/d/1-4MQ1ge4J9I5iQGHYlY3f0VR724S_eXp/view?usp=sharing" if curl --output /dev/null --silent --head --fail "$url"; then echo "The link is accessible." else echo "The link is not accessible or returns an error." fi
59-59: Verify the accessibility of the external link.Please check if the link to the Model Formulation presentation is accessible and up-to-date.
#!/bin/bash # Check if the link is accessible url="https://drive.google.com/file/d/1thabA0RBfSVYAIcKkgMOBFSZwhtmxvv2/view?usp=sharing" if curl --output /dev/null --silent --head --fail "$url"; then echo "The link is accessible." else echo "The link is not accessible or returns an error." fi
52-52: Verify the accessibility of the external link.Please check if the link to the GEOGLOWS History presentation is accessible and up-to-date.
#!/bin/bash # Check if the link is accessible url="https://drive.google.com/file/d/1dICEwFCFEIWnYgVAUNlrqsUMj487yp4o/view?usp=sharing" if curl --output /dev/null --silent --head --fail "$url"; then echo "The link is accessible." else echo "The link is not accessible or returns an error." fi
96-96: Verify the existence and relevance of the image.Please ensure that the file
image7.pngexists in the correct directory and that it's relevant to the Map subsection.#!/bin/bash # Verify the existence of image7.png if [ -f "docs/image7.png" ]; then echo "image7.png exists in the docs directory." else echo "image7.png does not exist in the docs directory." fi
104-104: Verify the existence and relevance of the image.Please ensure that the file
img9.pngexists in the correct directory and that it's relevant to the Retrospective Data subsection.#!/bin/bash # Verify the existence of img9.png if [ -f "docs/img9.png" ]; then echo "img9.png exists in the docs directory." else echo "img9.png does not exist in the docs directory." fi
134-134: Verify the accessibility of the external link.Please check if the link to the Stories presentation is accessible and up-to-date.
#!/bin/bash # Check if the link is accessible url="https://drive.google.com/file/d/1-CbslVlrtOyobNkR18uusWVdjqp0OsuW/view?usp=sharing" if curl --output /dev/null --silent --head --fail "$url"; then echo "The link is accessible." else echo "The link is not accessible or returns an error." fi
144-145: Verify the accessibility of the survey links.Please check if the links to the English and Spanish surveys are accessible and up-to-date.
#!/bin/bash # Check if the links are accessible english_url="https://forms.gle/eZr1nARB5L2kvMGy9" spanish_url="https://forms.gle/gjUedjP74PVb368w5" if curl --output /dev/null --silent --head --fail "$english_url"; then echo "The English survey link is accessible." else echo "The English survey link is not accessible or returns an error." fi if curl --output /dev/null --silent --head --fail "$spanish_url"; then echo "The Spanish survey link is accessible." else echo "The Spanish survey link is not accessible or returns an error." fi🧰 Tools
🪛 Markdownlint
144-144: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
145-145: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
140-140: Verify the accessibility of the external link.Please check if the link to join the Google Group is accessible and up-to-date.
#!/bin/bash # Check if the link is accessible url="https://groups.google.com/g/geoglows" if curl --output /dev/null --silent --head --fail "$url"; then echo "The link is accessible." else echo "The link is not accessible or returns an error." fi
3-3: Verify the existence and relevance of the image.Please ensure that the file
image3.pngexists in the correct directory and that it's relevant to the GEOGLOWS overview.
25-25: Verify the accessibility of the external link.Please check if the link to the GEOGLOWS V2 Overview presentation is accessible and up-to-date.
✅ Verification successful
The GEOGLOWS V2 Overview link is accessible.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check if the link is accessible url="https://drive.google.com/file/d/1h9skkuJQ-LR301nXSHjYRNHnso07gtac/view?usp=sharing" if curl --output /dev/null --silent --head --fail "$url"; then echo "The link is accessible." else echo "The link is not accessible or returns an error." fiLength of output: 443
Script:
#!/bin/bash # Verify the accessibility of the GEOGLOWS V2 Overview link url="https://drive.google.com/file/d/1h9skkuJQ-LR301nXSHjYRNHnso07gtac/view?usp=sharing" if curl --output /dev/null --silent --head --fail "$url"; then echo "The GEOGLOWS V2 Overview link is accessible." else echo "The GEOGLOWS V2 Overview link is not accessible or returns an error." fiLength of output: 323
| - Retrospective: retrospective.md | ||
| - Forecast: forecast.md | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider adding additional MkDocs configurations.
To further enhance your documentation, consider adding the following configurations:
- Repository URL:
repo_url: https://github.com/geoglows/training.geoglows.org- Markdown extensions for improved functionality:
markdown_extensions:
- admonition
- codehilite
- footnotes
- toc:
permalink: true- Extra settings for analytics and social links:
extra:
analytics:
provider: google
property: G-XXXXXXXXXX
social:
- icon: fontawesome/brands/github
link: https://github.com/geoglows
- icon: fontawesome/brands/twitter
link: https://twitter.com/geoglowsThese additions can improve the overall functionality and user experience of your documentation site. Adjust the values as needed to match your project's specifics.
| site_url: https://mydomain.org/mysite |
There was a problem hiding this comment.
Update the site_url to the correct GEOGLOWS training website URL.
The current site_url appears to be a placeholder. Please update it to the actual URL where the GEOGLOWS training website will be hosted.
For example, if the website will be hosted on GitHub Pages under the geoglows organization, the URL might look like:
site_url: https://geoglows.github.io/training.geoglows.org/Ensure to replace this with the correct URL for your deployment.
| ## Hydroviewer App | ||
| The GEOGLOWS Global HydroViewer is an essential tool for | ||
| visualizing and accessing streamflow forecasts and | ||
| historical data across the globe. This web-based application | ||
| allows users to explore real-time streamflow conditions, | ||
| analyze forecast trends, and review hydrological | ||
| simulations for any river, helping decision-makers | ||
| and researchers better understand water-related challenges. | ||
| With easy-to-use visualization tools, users can assess | ||
| discharge values and identify potential flood or drought | ||
| risks. The HydroViewer supports informed decision-making | ||
| in water resource management, disaster risk reduction, | ||
| and climate resilience planning. Access the app at | ||
| GEOGLOWS HydroViewer. | ||
|
|
||
|  | ||
|
|
||
| [Hydroviewer Tutorial](https://drive.google.com/file/d/1uuzKFHy520o2Hby5t91_geSMVEeKnKW5/view?usp=drive_link) |
There was a problem hiding this comment.
Add missing link to GEOGLOWS HydroViewer
The Hydroviewer App section provides excellent information about the tool's capabilities and importance. However, there's a minor omission:
The text mentions "Access the app at GEOGLOWS HydroViewer" but doesn't provide an actual hyperlink. Please add the correct URL for the GEOGLOWS HydroViewer app.
Example:
Access the app at [GEOGLOWS HydroViewer](https://geoglows.ecmwf.int/app/).Replace the URL with the correct one if different from the example.
| ### Map | ||
| * The GEOGloWS ECMWF Streamflow Model can be easily explored | ||
| using a mapping service developed in collaboration with | ||
| Esri (see: https://hydroviewer.geoglows.org/). The web map |
There was a problem hiding this comment.
Format the bare URL as a proper Markdown link.
Please format the bare URL as a proper Markdown link for better readability and to follow Markdown best practices.
Apply this change:
- using a mapping service developed in collaboration with
- Esri (see: https://hydroviewer.geoglows.org/). The web map
+ using a mapping service developed in collaboration with
+ Esri (see: [GEOGLOWS Hydroviewer](https://hydroviewer.geoglows.org/)). The web map Committable suggestion was skipped due to low confidence.
🧰 Tools
🪛 Markdownlint
88-88: null
Bare URL used(MD034, no-bare-urls)
docs/overview.md
Outdated
| * The GEOGLOWS ECMWF Streamflow Service leverages a Hydrologic | ||
| Modeling as a Service (HMaaS) approach, centralizing | ||
| cyberinfrastructure, expertise, and state-of-the-art | ||
| forecasting capabilities to provide reliable streamflow | ||
| data. Instead of requiring local agencies to manage and | ||
| compute vast amounts of data independently, GEOGLOWS | ||
| streamlines the process by using ensemble meteorological | ||
| forecasts from ECMWF, processed through the HTESSEL | ||
| land surface model. This generates global runoff data, | ||
| which is mapped to GEOGLOWS watersheds and routed through | ||
| river networks using the RAPID model to produce 15-day | ||
| forecasts. Additionally, the ERA-5 retrospective | ||
| historical data spanning over 80 years is used to | ||
| derive return periods, placing current forecasts | ||
| in a meaningful historical context. These streamflow | ||
| forecasts are accessible via web mapping services and APIs, | ||
| facilitating the development of customized applications | ||
| tailored to address local water management challenges | ||
| such as flooding, drought, and water security. | ||
|
|
||
| ### Map | ||
| * The GEOGloWS ECMWF Streamflow Model can be easily explored | ||
| using a mapping service developed in collaboration with | ||
| Esri (see: https://hydroviewer.geoglows.org/). The web map | ||
| allows users to visualize current streamflow conditions worldwide, | ||
| with line thickness indicating discharge magnitude and | ||
| line color showing if and when a river's discharge exceeds | ||
| the threshold for a specific return period. The app also | ||
| lets you select a specific stream to view both the forecast | ||
| and historical simulation data for that river. | ||
|
|
||
|  | ||
|
|
||
| ### Retrospective Data | ||
| * The retrospective (or historical) simulation is a deterministic | ||
| model with a daily resolution, covering the period from 1940 to the | ||
| present (over 80 years). This simulation helps calculate return | ||
| periods for maximum discharge values using the Gumbel Distribution, | ||
| providing essential context for interpreting hydrological forecasts. | ||
|  | ||
|
|
||
| ### Forecasts | ||
| * The forecast simulation has a 15-day horizon and includes | ||
| 52 ensemble members: 51 low-resolution members and 1 high-resolution | ||
| member with a 10-day horizon. The time resolution is 3-hour | ||
| intervals for low-resolution ensembles and 1-hour intervals for | ||
| the high-resolution member. The preferred forecast plot features | ||
| the median, 20th percentile, and 80th percentile (Uncertainty Bounds), | ||
| representing 60% of the probability distribution within the | ||
| ensemble members. | ||
|  |
There was a problem hiding this comment.
Address list indentation issues.
The static analysis tool has flagged inconsistent list indentation. Please ensure that all list items are indented consistently throughout the document.
Apply these changes:
- Remove the 2-space indentation from lines 65-66, 86-87, 99-100, and 107-108.
- Remove the 1-space indentation from lines 144-145.
For example:
- * The GEOGLOWS ECMWF Streamflow Service leverages a Hydrologic
- Modeling as a Service (HMaaS) approach, centralizing
+* The GEOGLOWS ECMWF Streamflow Service leverages a Hydrologic
+Modeling as a Service (HMaaS) approach, centralizing Apply this change consistently to all list items in the document.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * The GEOGLOWS ECMWF Streamflow Service leverages a Hydrologic | |
| Modeling as a Service (HMaaS) approach, centralizing | |
| cyberinfrastructure, expertise, and state-of-the-art | |
| forecasting capabilities to provide reliable streamflow | |
| data. Instead of requiring local agencies to manage and | |
| compute vast amounts of data independently, GEOGLOWS | |
| streamlines the process by using ensemble meteorological | |
| forecasts from ECMWF, processed through the HTESSEL | |
| land surface model. This generates global runoff data, | |
| which is mapped to GEOGLOWS watersheds and routed through | |
| river networks using the RAPID model to produce 15-day | |
| forecasts. Additionally, the ERA-5 retrospective | |
| historical data spanning over 80 years is used to | |
| derive return periods, placing current forecasts | |
| in a meaningful historical context. These streamflow | |
| forecasts are accessible via web mapping services and APIs, | |
| facilitating the development of customized applications | |
| tailored to address local water management challenges | |
| such as flooding, drought, and water security. | |
| ### Map | |
| * The GEOGloWS ECMWF Streamflow Model can be easily explored | |
| using a mapping service developed in collaboration with | |
| Esri (see: https://hydroviewer.geoglows.org/). The web map | |
| allows users to visualize current streamflow conditions worldwide, | |
| with line thickness indicating discharge magnitude and | |
| line color showing if and when a river's discharge exceeds | |
| the threshold for a specific return period. The app also | |
| lets you select a specific stream to view both the forecast | |
| and historical simulation data for that river. | |
|  | |
| ### Retrospective Data | |
| * The retrospective (or historical) simulation is a deterministic | |
| model with a daily resolution, covering the period from 1940 to the | |
| present (over 80 years). This simulation helps calculate return | |
| periods for maximum discharge values using the Gumbel Distribution, | |
| providing essential context for interpreting hydrological forecasts. | |
|  | |
| ### Forecasts | |
| * The forecast simulation has a 15-day horizon and includes | |
| 52 ensemble members: 51 low-resolution members and 1 high-resolution | |
| member with a 10-day horizon. The time resolution is 3-hour | |
| intervals for low-resolution ensembles and 1-hour intervals for | |
| the high-resolution member. The preferred forecast plot features | |
| the median, 20th percentile, and 80th percentile (Uncertainty Bounds), | |
| representing 60% of the probability distribution within the | |
| ensemble members. | |
|  | |
| * The GEOGLOWS ECMWF Streamflow Service leverages a Hydrologic | |
| Modeling as a Service (HMaaS) approach, centralizing | |
| cyberinfrastructure, expertise, and state-of-the-art | |
| forecasting capabilities to provide reliable streamflow | |
| data. Instead of requiring local agencies to manage and | |
| compute vast amounts of data independently, GEOGLOWS | |
| streamlines the process by using ensemble meteorological | |
| forecasts from ECMWF, processed through the HTESSEL | |
| land surface model. This generates global runoff data, | |
| which is mapped to GEOGLOWS watersheds and routed through | |
| river networks using the RAPID model to produce 15-day | |
| forecasts. Additionally, the ERA-5 retrospective | |
| historical data spanning over 80 years is used to | |
| derive return periods, placing current forecasts | |
| in a meaningful historical context. These streamflow | |
| forecasts are accessible via web mapping services and APIs, | |
| facilitating the development of customized applications | |
| tailored to address local water management challenges | |
| such as flooding, drought, and water security. | |
| ### Map | |
| * The GEOGloWS ECMWF Streamflow Model can be easily explored | |
| using a mapping service developed in collaboration with | |
| Esri (see: https://hydroviewer.geoglows.org/). The web map | |
| allows users to visualize current streamflow conditions worldwide, | |
| with line thickness indicating discharge magnitude and | |
| line color showing if and when a river's discharge exceeds | |
| the threshold for a specific return period. The app also | |
| lets you select a specific stream to view both the forecast | |
| and historical simulation data for that river. | |
|  | |
| ### Retrospective Data | |
| * The retrospective (or historical) simulation is a deterministic | |
| model with a daily resolution, covering the period from 1940 to the | |
| present (over 80 years). This simulation helps calculate return | |
| periods for maximum discharge values using the Gumbel Distribution, | |
| providing essential context for interpreting hydrological forecasts. | |
|  | |
| ### Forecasts | |
| * The forecast simulation has a 15-day horizon and includes | |
| 52 ensemble members: 51 low-resolution members and 1 high-resolution | |
| member with a 10-day horizon. The time resolution is 3-hour | |
| intervals for low-resolution ensembles and 1-hour intervals for | |
| the high-resolution member. The preferred forecast plot features | |
| the median, 20th percentile, and 80th percentile (Uncertainty Bounds), | |
| representing 60% of the probability distribution within the | |
| ensemble members. | |
|  |
🧰 Tools
🪛 Markdownlint
65-65: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
86-86: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
99-99: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
107-107: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
88-88: null
Bare URL used(MD034, no-bare-urls)
Summary by CodeRabbit
New Features
Documentation