No pdf #7
No pdf #7
Conversation
WalkthroughThe pull request revises and expands the documentation across several files. Changes include restructuring API documentation with added step-by-step instructions and new subsections, enhanced guidance for the GEOGLOWS Global HydroViewer, and updates to retrospective and forecast data descriptions. Navigation paths in the configuration file have been updated to reflect a new directory structure, and a publications section has been introduced. Additionally, legacy documentation has been removed and various image path adjustments have been made throughout. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant B as API Website
participant S as API Server
participant Py as Python Package
U->>B: Open API documentation
B->>U: Display form with instructions (river ID, parameters)
U->>B: Enter details and submit request
B->>S: Forward request for streamflow data
S-->>B: Return API response (CSV/JSON)
B->>U: Display results and visual aids
sequenceDiagram
participant U as User
participant M as Web Map Interface
participant P as Pop-up Window
participant D as Data Service
U->>M: Select a river on the map
M->>P: Show river info (name, ID, graphs)
P->>D: Request forecast and retrospective data
D-->>P: Return data for visualization
P->>U: Present detailed streamflow information
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
docs/forecast.md (1)
26-26: Enhance the explanation of probability distribution.The explanation of forecast plots could be more precise about the probability distribution.
Consider this revision:
- Forecast plots are designed to help users interpret the range of possible outcomes and uncertainties. The most commonly used forecast plot includes the median, the 20th percentile, and the 80th percentile. These represent 60% of the probability distribution within the ensemble members and provide insight into the potential variability of future streamflows. + Forecast plots are designed to help users interpret the range of possible outcomes and uncertainties. The most commonly used forecast plot includes the median (50th percentile), the 20th percentile, and the 80th percentile. The area between the 20th and 80th percentiles represents 60% of the probability distribution, meaning there is a 60% chance that the actual streamflow will fall within this range. This visualization provides insight into the potential variability of future streamflows.docs/retrospective.md (2)
11-11: Clarify the update schedule and lag time.The explanation of the update schedule could be more precise about the accumulation of lag time.
Consider this revision:
- The inputs to the hydrology model lag from real time by 5 days. Once a week, on Sunday at midnight UTC, the dataset is updated. On that Sunday, GEOGLOWS data will cover up until 5 days ago. On Saturday night, the lag will have accumulated to 12 days. + The inputs to the hydrology model have a minimum lag of 5 days from real time. The dataset is updated weekly on Sunday at midnight UTC, when the data will cover up until 5 days before the update. As the week progresses, this lag increases, reaching approximately 12 days by Saturday night before the next update.
26-28: Expand the return period calculations section.The return period section would benefit from more detail about the calculation methodology.
Consider adding:
## Return Period Calculations The retrospective simulation is used to define return periods that establish warning levels for each simulated river segment. Streamflow values for return periods of 2, 5, 10, 25, 50 and 100 years are calculated for every stream reach in the model. + + These return periods are calculated using statistical analysis of the historical flow data: + - The entire retrospective dataset (1940-present) is analyzed for each river segment + - Annual maximum flow values are extracted and fitted to a probability distribution + - Return period thresholds are then computed from this distribution + - These thresholds are used to establish warning levels in the forecasting systemdocs/data-service.md (2)
12-12: Simplify the introduction to river ID requirement.The language could be more concise while maintaining clarity.
- In order to use the API, most functions require you to know your river ID number. + Most API functions require a river ID number.
37-39: Add code example for Python usage.The Python section would benefit from a basic example.
Consider adding:
One of the easiest ways to access the API is through Python. There is a **GeoGLOWS Python package** (documented here: [GeoGLOWS API Documentation](https://geoglows.readthedocs.io/en/latest/api-documentation.html)) that contains commands for basic analysis and querying specific types of data. This Python notebook provides examples of using the API in Python, as well as utilizing the Python package: [Programmatic_Access Colab.ipynb](https://colab.research.google.com/drive/19PiUTU2noCvNGr6r-1i9cv0YMduTxATs?usp=sharing) + + Here's a basic example of retrieving forecast data: + ```python + import geoglows + + # Get forecast for a specific river + river_id = 123456789 + forecast = geoglows.streamflow.forecast(river_id) + ```docs/web-app.md (2)
29-31: Improve clarity of the zoom and selection instructions.The instructions could be more precise about the zoom levels and selection process.
- At the global level, only the largest streams are shown. More streams become visible as a user zooms in on the map and their area of interest. If you are not accurate enough in your click, a warning will show asking you to zoom in more and be more precise when clicking the river segment. + At the global level, only the largest streams are shown. As you zoom in to your area of interest, more detailed stream networks become visible. If you click on an area with multiple streams, a warning will appear asking you to zoom in further for more precise stream selection. - Once you have selected the streams, a pop-up window will appear with the river name, ID, and two graphs: the forecasted and retrospective streamflow data. + After selecting a specific stream segment, a pop-up window will display: + - The river name and ID + - A 15-day forecast graph + - A retrospective streamflow data graph🧰 Tools
🪛 LanguageTool
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...te enough in your click, a warning will show asking you to zoom in more and be more ...(AI_HYDRA_LEO_MISSING_COMMA)
35-35: Fix grammar in the download instructions.- Plots and `.csv` files can be downloaded for streams of interest by selecting the camera icon in the corner of the plot. + Plots and `.csv` files for streams of interest can be downloaded by selecting the camera icon in the corner of the plot.🧰 Tools
🪛 LanguageTool
[grammar] ~35-~35: The usual collocation for “interest” is “in”, not “by”.
Context: ... files can be downloaded for streams of interest by selecting the camera icon in the corner...(INTERESTED_BY)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
docs/api-window-pop-up.pngis excluded by!**/*.pngdocs/calendar-forecast.pngis excluded by!**/*.pngdocs/execute-button.pngis excluded by!**/*.pngdocs/filtered-streams.pngis excluded by!**/*.pngdocs/loaded-graph.pngis excluded by!**/*.pngdocs/response-api.pngis excluded by!**/*.pngdocs/retrospective-variable.pngis excluded by!**/*.png
📒 Files selected for processing (7)
docs/GIS-data.md(1 hunks)docs/data-service.md(1 hunks)docs/forecast.md(1 hunks)docs/loaded-graph.png:Zone.Identifier(1 hunks)docs/retrospective.md(2 hunks)docs/web-app.md(1 hunks)mkdocs.yml(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- docs/GIS-data.md
- mkdocs.yml
- docs/loaded-graph.png:Zone.Identifier
🧰 Additional context used
🪛 LanguageTool
docs/web-app.md
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...te enough in your click, a warning will show asking you to zoom in more and be more ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~35-~35: The usual collocation for “interest” is “in”, not “by”.
Context: ... files can be downloaded for streams of interest by selecting the camera icon in the corner...
(INTERESTED_BY)
[uncategorized] ~53-~53: Consider adding a hyphen.
Context: ...ther by selecting the chart icon in the upper right corner or by it being open from a previ...
(TOP_LEFT_CORNER)
docs/data-service.md
[style] ~11-~11: Consider a shorter alternative to avoid wordiness.
Context: ...image --- ## Using the API In order to use the API, most functions require you...
(IN_ORDER_TO_PREMIUM)
🔇 Additional comments (3)
docs/forecast.md (1)
15-19: LGTM! Clear and accurate explanation of the forecast process.The added technical details about the forecast update process, spatial resolution, and model workflow provide valuable context for users. The explanation is technically accurate and aligns well with the overall documentation.
docs/data-service.md (1)
24-27: LGTM! Clear and comprehensive input instructions.The step-by-step instructions with specific format requirements are well-detailed and helpful.
docs/web-app.md (1)
62-67: LGTM! Clear and well-structured filtering options.The filtering options are clearly presented in a logical hierarchy.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
docs/publications.md (3)
1-4: Clarify Verb Tense in Introduction
The introduction clearly sets the context for the publications. One minor nitpick is the verb tense in line 3. Using “contribute” implies an ongoing process, but since the publications are a result of past work, consider using “have contributed” or “contributed” for consistency.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...ge that many scientists and researchers contribute to the successful development and opera...(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
14-23: Review of Formative Research Section
The “Formative Research” section is comprehensive and informative. As a suggestion, consider a slight rewording where phrases like “in Support of” appear—opting for a shorter alternative (e.g., “for”) can improve readability.
24-33: Balanced Detail in Bias Correction Section
The “Bias Correction” section provides detailed publication entries that are well formatted. One minor note: for compound adjectives (for instance, descriptors of software like “open source”), hyphenating them (i.e. “open-source”) can improve clarity.🧰 Tools
🪛 LanguageTool
[style] ~32-~32: ‘in Support of’ might be wordy. Consider a shorter alternative.
Context: ...l Runoff Datasets through a River Model in Support of Transboundary Water Management in South...(EN_WORDINESS_PREMIUM_IN_SUPPORT_OF)
docs/GIS-data.md (1)
27-35: Verify Attribute Naming Consistency in Metadata
In the “Available Metadata” section (line 34), the attribute LengthGeodesucMaters is used. Please verify that this naming is intended; if the goal is to represent geodesic length in meters, a more conventional naming might be “LengthGeodesicMeters”.-**LengthGeodesucMaters** +**LengthGeodesicMeters**docs/overview copy.md (1)
5-12: Overview Section: Clarity and Conciseness
The “Overview” section provides a clear description of the GEOGLOWS initiative and the critical role of the River Forecast System (RFS). Consider verifying that the expanded term “Global Earth Observations Global Water Sustainability” best represents the acronym. Some readers might benefit from a brief explanatory note or reordering for better clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/GIS-data.md(3 hunks)docs/index.md(0 hunks)docs/overview copy.md(1 hunks)docs/publications.md(1 hunks)mkdocs.yml(2 hunks)
💤 Files with no reviewable changes (1)
- docs/index.md
🚧 Files skipped from review as they are similar to previous changes (1)
- mkdocs.yml
🧰 Additional context used
🪛 LanguageTool
docs/GIS-data.md
[grammar] ~8-~8: Two determiners in a row. Choose either “the” or “an”.
Context: ...eam centerlines connect. Each point has the an attribute called DSLINKNO which represe...
(DT_DT)
docs/publications.md
[uncategorized] ~3-~3: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...ge that many scientists and researchers contribute to the successful development and opera...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[style] ~32-~32: ‘in Support of’ might be wordy. Consider a shorter alternative.
Context: ...l Runoff Datasets through a River Model in Support of Transboundary Water Management in South...
(EN_WORDINESS_PREMIUM_IN_SUPPORT_OF)
[uncategorized] ~64-~64: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...g – A review of common practices and an open source library to facilitate use and adoption*...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/overview copy.md
[uncategorized] ~48-~48: “out” (outside) seems less likely than “our” (belonging to us).
Context: ...ore about our model, RFS, continue with out training under the River Forecast Syste...
(AI_HYDRA_LEO_CP_OUT_OUR)
[misspelling] ~48-~48: This word is normally spelled as one.
Context: ... 3 main sections, each having different sub sections within them. We recommend you start wit...
(EN_COMPOUNDS_SUB_SECTIONS)
[style] ~48-~48: Consider using a more formal alternative.
Context: ... there is also a website available with more information on how to download and use the RFS data...
(MORE_INFO)
🪛 markdownlint-cli2 (0.17.2)
docs/overview copy.md
48-48: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (6)
docs/publications.md (2)
5-13: Consistent Formatting for Publication Entries
The “GEOGLOWS Hydrologic Model” and “GEOGLOWS V1” sections are well structured with clearly delineated publication entries (authors, titles, journals, and links). Please double-check that the publication details (DOI/link and author order) are fully accurate and in line with official records.
34-45: Validation and Example Use Cases Sections
The “Validation” and “Example Use Cases” sections continue the consistent presentation of publication details. Ensure that all DOI and URL links are current. Overall, the sections are clear and well organized.docs/GIS-data.md (2)
4-5: Clear Introduction of GIS Dataset Components
The opening description on lines 4–5 clearly introduces the four main components of the GIS dataset. The explanation is concise and accessible for users.
9-11: Detailed Description for Merged Lake Catchments
The description for merged lake catchments is detailed and clearly explains how lakes are represented in the model. Confirm that the file naming convention (e.g., "lakes_{vpu}.gpkg") is consistent with the established guidelines.docs/overview copy.md (2)
1-4: Effective Introduction and Visual Engagement
The opening lines and the image inclusion are engaging and set a positive tone for the document. The title is clear and draws readers into understanding what GEOGLOWS entails.
51-67: Well-Structured Training Content and Application Stories
The subsequent sections outlining “Skills and Examples”, “Stories of Application”, and “Joining GEOGLOWS” are clearly structured. The comprehensive details make it easy for users to understand the data access methods and community engagement opportunities.
docs/GIS-data.md
Outdated
| - The exact **stream center lines** used in the hydrologic model. Each stream has a unique 9 number ID which is referred to as a reachID, link number, or stream ID. This is the file called "streams_{vpu}.gpkg". | ||
| - The **catchment boundaries** used in the hydrologic model. There are the boundaries around each of the streamlines and represent the area connected to that streamline. It is identified using the same link number as the stream center lines. This is the file called "catchments_{vpu}.spatialite". Each stream centerline corresponds to exactly one unique catchment boundary. | ||
| - The **connection points** used in the hydrologic model where different stream centerlines connect. Each point has the an attribute called DSLINKNO which represents the one downstream link number for each of the points. It has another attribute called USLINKNOs. This is a comma seperated list of the link numbers upstream of the nexus point. This is the file called "nexus_{vpu}.gpkg". | ||
| - The **merged lake catchments** used in the hydrologic model to represent the locations of lakes. Stream catchments that were identified through GIS searching to be part of a lake were merged to present the lakes. Therefore, it will have a different shape than the actual lake boundary based on the shapes of the merged stream catchments. This is the file called "lakes_{vpu}.gpkg". |
There was a problem hiding this comment.
Fix Determiner Duplication and Maintain Clarity
In the bullet describing the connection points (line 8), there is a minor typographical issue: “each point has the an attribute” should be corrected to “each point has an attribute” to remove the duplicate determiner.
-Each point has the an attribute called DSLINKNO...
+Each point has an attribute called DSLINKNO...📝 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 exact **stream center lines** used in the hydrologic model. Each stream has a unique 9 number ID which is referred to as a reachID, link number, or stream ID. This is the file called "streams_{vpu}.gpkg". | |
| - The **catchment boundaries** used in the hydrologic model. There are the boundaries around each of the streamlines and represent the area connected to that streamline. It is identified using the same link number as the stream center lines. This is the file called "catchments_{vpu}.spatialite". Each stream centerline corresponds to exactly one unique catchment boundary. | |
| - The **connection points** used in the hydrologic model where different stream centerlines connect. Each point has the an attribute called DSLINKNO which represents the one downstream link number for each of the points. It has another attribute called USLINKNOs. This is a comma seperated list of the link numbers upstream of the nexus point. This is the file called "nexus_{vpu}.gpkg". | |
| - The **merged lake catchments** used in the hydrologic model to represent the locations of lakes. Stream catchments that were identified through GIS searching to be part of a lake were merged to present the lakes. Therefore, it will have a different shape than the actual lake boundary based on the shapes of the merged stream catchments. This is the file called "lakes_{vpu}.gpkg". | |
| - The exact **stream center lines** used in the hydrologic model. Each stream has a unique 9 number ID which is referred to as a reachID, link number, or stream ID. This is the file called "streams_{vpu}.gpkg". | |
| - The **catchment boundaries** used in the hydrologic model. There are the boundaries around each of the streamlines and represent the area connected to that streamline. It is identified using the same link number as the stream center lines. This is the file called "catchments_{vpu}.spatialite". Each stream centerline corresponds to exactly one unique catchment boundary. | |
| - The **connection points** used in the hydrologic model where different stream centerlines connect. Each point has an attribute called DSLINKNO which represents the one downstream link number for each of the points. It has another attribute called USLINKNOs. This is a comma seperated list of the link numbers upstream of the nexus point. This is the file called "nexus_{vpu}.gpkg". | |
| - The **merged lake catchments** used in the hydrologic model to represent the locations of lakes. Stream catchments that were identified through GIS searching to be part of a lake were merged to present the lakes. Therefore, it will have a different shape than the actual lake boundary based on the shapes of the merged stream catchments. This is the file called "lakes_{vpu}.gpkg". |
🧰 Tools
🪛 LanguageTool
[grammar] ~8-~8: Two determiners in a row. Choose either “the” or “an”.
Context: ...eam centerlines connect. Each point has the an attribute called DSLINKNO which represe...
(DT_DT)
docs/overview copy.md
Outdated
| ## River Forecast System Training | ||
| To learn more about our model, RFS, continue with out training under the River Forecast System portion of this website. This training is broken down into 3 main sections, each having different sub sections within them. We recommend you start with the first section (Available Data) before progressing to the second section (Accessing Data). The third section (Skills and Examples) is a more advanced section designed for people looking to complete specific tasks using the RFS data who already have a good understanding of the first two sections. As you are learning about the data, there is also a website available with more information on how to download and use the RFS data: https://data.geoglows.org/. This is a great resource once you have a basic understanding of the data. Here is a brief overview of what you can expect to learn: | ||
|
|
||
| 1. **Available Data** - This section details the available datasets from RFS. It is divided into 3 sections: |
There was a problem hiding this comment.
Typographical Corrections in the Training Section
In the “River Forecast System Training” section, there are a couple of small issues on lines 47–50:
- “with out training” should be corrected to “with our training”.
- The phrase “different sub sections” should be updated to “different subsections” (as one word).
- Consider a more formal alternative to “more information on how to download and use the RFS data” if consistency with the rest of the document is desired.
-continue with out training under the River Forecast System portion of this website.
+continue with our training under the River Forecast System portion of this website.
-each having different sub sections within them.
+each having different subsections within them.📝 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.
| ## River Forecast System Training | |
| To learn more about our model, RFS, continue with out training under the River Forecast System portion of this website. This training is broken down into 3 main sections, each having different sub sections within them. We recommend you start with the first section (Available Data) before progressing to the second section (Accessing Data). The third section (Skills and Examples) is a more advanced section designed for people looking to complete specific tasks using the RFS data who already have a good understanding of the first two sections. As you are learning about the data, there is also a website available with more information on how to download and use the RFS data: https://data.geoglows.org/. This is a great resource once you have a basic understanding of the data. Here is a brief overview of what you can expect to learn: | |
| 1. **Available Data** - This section details the available datasets from RFS. It is divided into 3 sections: | |
| ## River Forecast System Training | |
| To learn more about our model, RFS, continue with our training under the River Forecast System portion of this website. This training is broken down into 3 main sections, each having different subsections within them. We recommend you start with the first section (Available Data) before progressing to the second section (Accessing Data). The third section (Skills and Examples) is a more advanced section designed for people looking to complete specific tasks using the RFS data who already have a good understanding of the first two sections. As you are learning about the data, there is also a website available with more information on how to download and use the RFS data: https://data.geoglows.org/. This is a great resource once you have a basic understanding of the data. Here is a brief overview of what you can expect to learn: |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: “out” (outside) seems less likely than “our” (belonging to us).
Context: ...ore about our model, RFS, continue with out training under the River Forecast Syste...
(AI_HYDRA_LEO_CP_OUT_OUR)
[misspelling] ~48-~48: This word is normally spelled as one.
Context: ... 3 main sections, each having different sub sections within them. We recommend you start wit...
(EN_COMPOUNDS_SUB_SECTIONS)
[style] ~48-~48: Consider using a more formal alternative.
Context: ... there is also a website available with more information on how to download and use the RFS data...
(MORE_INFO)
🪛 markdownlint-cli2 (0.17.2)
48-48: Bare URL used
null
(MD034, no-bare-urls)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (9)
docs/retrospective.md (3)
3-3: Style Suggestion: Consider Punctuating the Date for Clarity
The sentence on line 3 ("...historical streamflow data from January 1, 1940 to the near present...") might benefit from a comma after the day/year ("January 1, 1940,") to conform to some style guides.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...torical streamflow data from January 1, 1940 to the near present. Each of the 6 mill...(MISSING_COMMA_AFTER_YEAR)
11-12: Readability Suggestion: Update Frequency Description
The description of the update lag (lines 11–12) is informative. You might consider splitting the longer sentence into two for enhanced readability, though the current structure is acceptable if clarity is maintained.
13-16: Content Completeness: Averaging Methods and Format Options
The detailed explanation of the various averaging methods and the two available formats for monthly data (lines 13–16) is comprehensive. Consider if a brief note on which use cases might favor one format over the other could further assist users.docs/exercises.md (1)
23-23: Consistency Suggestion: Rebranding to RFS
On line 23, the text still refers to the "GEOGLOWS Model" for accessing forecast data. In light of the broader rebranding effort toward "RFS" throughout the documentation, consider updating this reference for consistency.docs/data-service.md (1)
10-13: Conciseness Suggestion: API Usage Introduction
The introductory instructions for using the API (lines 10–13) are clear; however, you might consider rephrasing to reduce wordiness. For example, starting with "Most API functions require a river ID number..." could streamline the instructions.🧰 Tools
🪛 LanguageTool
[style] ~11-~11: Consider a shorter alternative to avoid wordiness.
Context: ...image --- ## Using the API In order to use the API, most functions require you...(IN_ORDER_TO_PREMIUM)
docs/GIS-data.md (1)
34-34: Typographical Suggestion: Attribute Name Consistency
The attribute "LengthGeodesucMaters" (line 34) appears to be a typographical error. Consider standardizing it—perhaps to "Length (meters)" or "Geodesic Length in Meters"—to ensure clarity for users and consistency with common terminology.docs/forecasted-bias-correction.md (2)
3-3: Punctuation Suggestion: Missing Comma for Readability
In the sentence on line 3, consider adding a comma after "flow duration curve" to separate the clauses, which would improve readability. For example: "...using the historical simulation's flow duration curve, and then replacing..."🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: Possible missing comma found.
Context: ...e historical simulation's flow duration curve and then replacing the forecasted value...(AI_HYDRA_LEO_MISSING_COMMA)
17-17: Consistency Suggestion: Update Rebranding References
On line 17, the phrase "bias correction on GEOGLOWS forecast values" is used. In keeping with the overarching shift to the RFS terminology throughout the documentation, consider updating this reference to "RFS forecast values" for uniformity.docs/bias-correction.md (1)
3-3: Improve phrasing for clarity and active voice.
The added text currently uses a passive construction ("are able to be used") which can be made more succinct and active. Consider rephrasing the sentence as:
"Local users can have more confidence in their data because their observed data can be used to improve the modeled data at their location."
This change addresses both clarity and the stylistic suggestions provided by LanguageTool.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... they can know that their observed data is able to be used to improve the modeled data at ...(BE_ABLE_TO)
[style] ~3-~3: Avoid the passive voice after ‘to be able to’.
Context: ...now that their observed data is able to be used to improve the modeled data at their lo...(ABLE_TO_PASSIVE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
docs/GIS-data.md(3 hunks)docs/bias-correction.md(2 hunks)docs/data-catalog.md(1 hunks)docs/data-service.md(1 hunks)docs/exercises.md(1 hunks)docs/forecast.md(2 hunks)docs/forecasted-bias-correction.md(1 hunks)docs/retrospective.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/data-catalog.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/forecast.md
🧰 Additional context used
🪛 LanguageTool
docs/data-service.md
[style] ~11-~11: Consider a shorter alternative to avoid wordiness.
Context: ...image --- ## Using the API In order to use the API, most functions require you...
(IN_ORDER_TO_PREMIUM)
docs/retrospective.md
[style] ~3-~3: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...torical streamflow data from January 1, 1940 to the near present. Each of the 6 mill...
(MISSING_COMMA_AFTER_YEAR)
docs/GIS-data.md
[grammar] ~8-~8: Two determiners in a row. Choose either “the” or “an”.
Context: ...eam centerlines connect. Each point has the an attribute called DSLINKNO which represe...
(DT_DT)
docs/bias-correction.md
[style] ~3-~3: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... they can know that their observed data is able to be used to improve the modeled data at ...
(BE_ABLE_TO)
[style] ~3-~3: Avoid the passive voice after ‘to be able to’.
Context: ...now that their observed data is able to be used to improve the modeled data at their lo...
(ABLE_TO_PASSIVE)
docs/forecasted-bias-correction.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: ...e historical simulation's flow duration curve and then replacing the forecasted value...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (8)
docs/retrospective.md (2)
9-10: Content Clarity: Deterministic Data Explanation
The explanation on lines 9–10 clearly states that the dataset is deterministic with a single best guess of average flows. This clarity is helpful; no changes are necessary here.
26-29: New Section Review: Return Period Calculations
The newly introduced "Return Period Calculations" section (lines 26–29) is clear and succinct. It effectively communicates the process and the specific return period intervals. If further technical detail (e.g., calculation methodology) is provided elsewhere, a cross-reference here might benefit users.docs/exercises.md (1)
3-6: Clarity and Detail: Hydrological Analysis Explanation
The description of how return periods and Flow Duration Curves (FDCs) are used (lines 3–6) is detailed and informative. No significant issues are found; the content is well-structured.docs/data-service.md (2)
14-34: Clarity and User Guidance: API Website Instructions
The step-by-step guide for using the API Website (lines 14–34) is user-friendly and well-documented with visual aids. This section is clear and does not require modifications.
35-42: Python Access Instructions: Clear and Informative
The explanation on accessing the API using Python (lines 35–42) is concise and provides helpful resource links. Ensure that the package name and documentation links remain current.docs/GIS-data.md (2)
4-4: Content Detail: GIS Data Overview
The overview on line 4 concisely explains the GEOGLOWS GIS data and its components. The terminology is clear and aligns with the RFS context.
15-20: Clarity: VPU Description is Clear
The explanation regarding VPUs (lines 15–20) is well written and the accompanying image aids understanding. No revisions are necessary.docs/bias-correction.md (1)
21-21: Clarify and streamline the description of the SABER team's role.
The revised paragraph states:
"Unlike bias-correction, which each institution performs locally, SABER is performed by the GEOGLOWS team and is not done by the end users. We use the gauge data made available to us to perform an improvement to all the model results. This process is still in experimentation and is not currently being applied to the data accessed by the end-users. We hope for it to be applied in future versions of RFS."
Consider rephrasing for clarity and conciseness—for example:
"Unlike bias-correction, which is executed locally by each institution, SABER is performed by the GEOGLOWS team rather than the end users. We use the available gauge data to improve all model results. Although this process is still experimental and is not yet applied to user-accessed data, we hope it will be implemented in future versions of RFS."
This phrasing reduces passive voice and improves readability. Additionally, please verify that retaining the reference to the "GEOGLOWS team" aligns with the overall rebranding to RFS.
| - The exact **stream center lines** used in RFS. Each stream has a unique 9 number ID which is referred to as a reachID, link number, or stream ID. This is the file called "streams_{vpu}.gpkg". | ||
| - The **catchment boundaries** used RFS. There are the boundaries around each of the streamlines and represent the area connected to that streamline. It is identified using the same link number as the stream center lines. This is the file called "catchments_{vpu}.spatialite". Each stream centerline corresponds to exactly one unique catchment boundary. | ||
| - The **connection points** used in RFS where different stream centerlines connect. Each point has the an attribute called DSLINKNO which represents the one downstream link number for each of the points. It has another attribute called USLINKNOs. This is a comma seperated list of the link numbers upstream of the nexus point. This is the file called "nexus_{vpu}.gpkg". | ||
| - The **merged lake catchments** used in RFS to represent the locations of lakes. Stream catchments that were identified through GIS searching to be part of a lake were merged to present the lakes. Therefore, it will have a different shape than the actual lake boundary based on the shapes of the merged stream catchments. This is the file called "lakes_{vpu}.gpkg". |
There was a problem hiding this comment.
Grammar and Typographical Corrections Needed in Bullet Points
- On line 8, the phrase "Each point has the an attribute" contains a duplicate determiner. It should be corrected to "Each point has an attribute."
- Additionally, "comma seperated list" should be corrected to "comma separated list."
These fixes will improve clarity and professionalism in the documentation.
🧰 Tools
🪛 LanguageTool
[grammar] ~8-~8: Two determiners in a row. Choose either “the” or “an”.
Context: ...eam centerlines connect. Each point has the an attribute called DSLINKNO which represe...
(DT_DT)
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
docs/rfs/skills_examples/exercises.md (1)
22-23: Inconsistent Terminology in Forecast Simulation Section
The "Forecast Simulation" section still references the “GEOGLOWS Model”, which conflicts with the updated branding to "RFS" as indicated in the PR and other documentation sections.Consider applying the following change for consistency:
-The Colab notebook provides an interactive guide on accessing and visualizing forecast data from the GEOGLOWS Model. +The Colab notebook provides an interactive guide on accessing and visualizing forecast data from the RFS.
🧹 Nitpick comments (14)
docs/overview copy.md (1)
3-3: Accessibility Improvement: Add Descriptive Alt Text
The image on line 3 currently has no descriptive alt text. For accessibility and improved SEO, consider updating it with a descriptive text (e.g., "GEOGLOWS overview graphic").docs/rfs/accessing_data/web-app.md (4)
1-3: Consider Standardizing Terminology.
The introduction currently refers to the “GEOGLOWS Global HydroViewer.” Given that previous updates have standardized terminology to “RFS” in related documentation, please verify if this should be updated for consistency.
25-25: Consolidate and Clarify Download Instructions.
There are two similar instructions regarding downloading plots and .csv files (one on line 25 and another on line 35). To enhance clarity and avoid redundancy, consider consolidating these statements. Additionally, in line 35, rephrase “by selecting the camera icon in the corner of the plot” to something like “using the camera icon in the corner of the plot” for improved readability.Also applies to: 35-35
33-34: Check for Typographical Error in Image Alt Text.
The alt text “loaded-datat” appears to be a typo; consider updating it to “loaded-data” to accurately describe the image.
49-57: Clarify the “Entering a River ID” Instructions.
The step-by-step guide is comprehensive; however, consider refining Step 1 to streamline the instruction. For example, instead of “Get the chart pop-up window open either by selecting the chart icon in the upper right corner or by it being open from a previous river selection,” you might say “Open the chart pop-up window by clicking the chart icon in the upper right corner or by using an already open window.” This change, along with ensuring consistent hyphenation for “pop-up,” could improve readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~53-~53: Consider adding a hyphen.
Context: ...ther by selecting the chart icon in the upper right corner or by it being open from a previ...(TOP_LEFT_CORNER)
docs/rfs/available_data/retrospective.md (1)
3-3: Clarify Date Formatting in Historical Data Description
The text describes historical data "from January 1, 1940 to the near present." Some style guides recommend setting off the year with a comma. Consider updating the text to "from January 1, 1940, to the near present" for improved readability.Proposed diff:
-... historical streamflow data from January 1, 1940 to the near present. +... historical streamflow data from January 1, 1940, to the near present.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...torical streamflow data from January 1, 1940 to the near present. Each of the 6 mill...(MISSING_COMMA_AFTER_YEAR)
docs/rfs/skills_examples/bias-correction.md (2)
3-3: Refine Wording for Clarity
The updated sentence at line 3 is clear in intent, but it can be made more concise and direct. Consider rephrasing to reduce wordiness and avoid the passive construction. For example:
"Local users can have more confidence in their data because they now know that their observed data can improve the modeled data at their location."
[static_analysis]
Suggested diff:-Local users can have more confidence in their data because they can know that their observed data is able to be used to improve the modeled data at their location. +Local users can have more confidence in their data because they now know that their observed data can improve the modeled data at their location.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... they can know that their observed data is able to be used to improve the modeled data at ...(BE_ABLE_TO)
[style] ~3-~3: Avoid the passive voice after ‘to be able to’.
Context: ...now that their observed data is able to be used to improve the modeled data at their lo...(ABLE_TO_PASSIVE)
21-21: Clarify Process Description
The phrase "perform an improvement to all the model results" feels awkward. A simpler phrasing like "enhance all the model results" would improve clarity.Suggested diff:
-We use the gauge data made available to us to perform an improvement to all the model results. +We use the gauge data provided to enhance all the model results.docs/overview.md (1)
65-83: Consider Adjusting Unordered List Indentation
Static analysis has flagged an unordered list indentation issue (MD007: Expected 0 spaces; Actual 2). Adjusting the indentation of bullet list items (e.g., within the "Hydrofabric" section) to start at the beginning of the line could improve markdown consistency.Suggested diff for one list item:
- * 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🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
65-65: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
docs/rfs/available_data/GIS-data.md (5)
4-4: Clarify Data Terminology Consistency
The introduction states “The GEOGLOWS GIS data used in RFS…” which mixes the legacy GEOGLOWS label with the new RFS context. Consider clarifying whether the term should be updated throughout or if this historical reference is intentional.
6-6: Refine Stream Center Lines Description
The line “- The exact stream center lines used in RFS. Each stream has a unique 9 number ID…” could be made clearer. For instance, consider revising “unique 9 number ID” to “unique 9-digit stream ID” (if appropriate) and review whether the qualifier “exact” is needed.
7-7: Improve Catchment Boundaries Grammar
The sentence “- The catchment boundaries used RFS…” seems to be missing a preposition. A rephrasing to “- The catchment boundaries used in RFS…” would read more clearly. Additionally, the clause “There are the boundaries around each of the streamlines…” might be improved for clarity (e.g., “These boundaries encompass each stream centerline…”).
8-8: Fix Grammatical Errors in Connection Points Section
There are a couple of grammatical issues:
• “Each point has the an attribute called DSLINKNO…” contains a duplicate article.
• “This is a comma seperated list…” uses “seperated” instead of “separated.”
Consider applying the following diff:-Each point has the an attribute called DSLINKNO which represents the one downstream link number for each of the points. It has another attribute called USLINKNOs. This is a comma seperated list of the link numbers upstream of the nexus point. +Each point has an attribute called DSLINKNO, which represents the downstream link number for the point. It also has an attribute called USLINKNOs, which is a comma-separated list of the link numbers upstream of the nexus point.🧰 Tools
🪛 LanguageTool
[grammar] ~8-~8: Two determiners in a row. Choose either “the” or “an”.
Context: ...eam centerlines connect. Each point has the an attribute called DSLINKNO which represe...(DT_DT)
19-19: Clarify Download Instructions for VPU Boundaries
While the line is clear, the phrase “downloaded as an entire VPU” might be slightly ambiguous. Consider rephrasing it to “downloaded as a complete VPU dataset” to improve clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (33)
docs/static/images/api-window-pop-up.pngis excluded by!**/*.pngdocs/static/images/api.pngis excluded by!**/*.pngdocs/static/images/aws_bucket.pngis excluded by!**/*.pngdocs/static/images/bias-metrics.pngis excluded by!**/*.pngdocs/static/images/calendar-forecast.pngis excluded by!**/*.pngdocs/static/images/execute-button.pngis excluded by!**/*.pngdocs/static/images/filtered-streams.pngis excluded by!**/*.pngdocs/static/images/forecast-bias-correction.pngis excluded by!**/*.pngdocs/static/images/global_kge1.pngis excluded by!**/*.pngdocs/static/images/global_kge2.pngis excluded by!**/*.pngdocs/static/images/hydroviewer.pngis excluded by!**/*.pngdocs/static/images/image3.pngis excluded by!**/*.pngdocs/static/images/image5.pngis excluded by!**/*.pngdocs/static/images/imagen.pngis excluded by!**/*.pngdocs/static/images/img10.pngis excluded by!**/*.pngdocs/static/images/img13.pngis excluded by!**/*.pngdocs/static/images/img14.pngis excluded by!**/*.pngdocs/static/images/img15.pngis excluded by!**/*.pngdocs/static/images/img17.pngis excluded by!**/*.pngdocs/static/images/img18.pngis excluded by!**/*.pngdocs/static/images/img19.pngis excluded by!**/*.pngdocs/static/images/img23.pngis excluded by!**/*.pngdocs/static/images/img8.pngis excluded by!**/*.pngdocs/static/images/img9.pngis excluded by!**/*.pngdocs/static/images/kge2.pngis excluded by!**/*.pngdocs/static/images/loaded-graph.pngis excluded by!**/*.pngdocs/static/images/response-api.pngis excluded by!**/*.pngdocs/static/images/retrospective-variable.pngis excluded by!**/*.pngdocs/static/images/retrospective_graph.pngis excluded by!**/*.pngdocs/static/images/river-legend.pngis excluded by!**/*.pngdocs/static/images/saber.pngis excluded by!**/*.pngdocs/static/images/screenshot.pngis excluded by!**/*.pngdocs/static/images/vpu-boundary.pngis excluded by!**/*.png
📒 Files selected for processing (15)
docs/accessing-data.md(0 hunks)docs/index.md(1 hunks)docs/overview copy.md(1 hunks)docs/overview.md(3 hunks)docs/rfs/accessing_data/data-catalog.md(2 hunks)docs/rfs/accessing_data/data-service.md(1 hunks)docs/rfs/accessing_data/web-app.md(1 hunks)docs/rfs/accessing_data/web_map.md(1 hunks)docs/rfs/available_data/GIS-data.md(3 hunks)docs/rfs/available_data/forecast.md(3 hunks)docs/rfs/available_data/retrospective.md(1 hunks)docs/rfs/skills_examples/bias-correction.md(2 hunks)docs/rfs/skills_examples/exercises.md(1 hunks)docs/rfs/skills_examples/forecasted-bias-correction.md(1 hunks)mkdocs.yml(1 hunks)
💤 Files with no reviewable changes (1)
- docs/accessing-data.md
✅ Files skipped from review due to trivial changes (2)
- docs/rfs/accessing_data/web_map.md
- docs/rfs/skills_examples/forecasted-bias-correction.md
🚧 Files skipped from review as they are similar to previous changes (1)
- mkdocs.yml
🧰 Additional context used
🪛 LanguageTool
docs/rfs/accessing_data/web-app.md
[grammar] ~35-~35: The usual collocation for “interest” is “in”, not “by”.
Context: ... files can be downloaded for streams of interest by selecting the camera icon in the corner...
(INTERESTED_BY)
[uncategorized] ~53-~53: Consider adding a hyphen.
Context: ...ther by selecting the chart icon in the upper right corner or by it being open from a previ...
(TOP_LEFT_CORNER)
docs/rfs/accessing_data/data-service.md
[style] ~11-~11: Consider a shorter alternative to avoid wordiness.
Context: .../images/api.png) --- ## Using the API In order to use the API, most functions require you...
(IN_ORDER_TO_PREMIUM)
docs/overview copy.md
[uncategorized] ~48-~48: “out” (outside) seems less likely than “our” (belonging to us).
Context: ...ore about our model, RFS, continue with out training under the River Forecast Syste...
(AI_HYDRA_LEO_CP_OUT_OUR)
[misspelling] ~48-~48: This word is normally spelled as one.
Context: ... 3 main sections, each having different sub sections within them. We recommend you start wit...
(EN_COMPOUNDS_SUB_SECTIONS)
[style] ~48-~48: Consider using a more formal alternative.
Context: ... there is also a website available with more information on how to download and use the RFS data...
(MORE_INFO)
docs/rfs/available_data/GIS-data.md
[grammar] ~8-~8: Two determiners in a row. Choose either “the” or “an”.
Context: ...eam centerlines connect. Each point has the an attribute called DSLINKNO which represe...
(DT_DT)
docs/rfs/available_data/retrospective.md
[style] ~3-~3: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...torical streamflow data from January 1, 1940 to the near present. Each of the 6 mill...
(MISSING_COMMA_AFTER_YEAR)
docs/rfs/skills_examples/bias-correction.md
[style] ~3-~3: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... they can know that their observed data is able to be used to improve the modeled data at ...
(BE_ABLE_TO)
[style] ~3-~3: Avoid the passive voice after ‘to be able to’.
Context: ...now that their observed data is able to be used to improve the modeled data at their lo...
(ABLE_TO_PASSIVE)
🪛 markdownlint-cli2 (0.17.2)
docs/overview.md
100-100: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
🔇 Additional comments (35)
docs/rfs/skills_examples/exercises.md (2)
3-3: Precise Update on Distribution Description
The updated passage clearly explains why the Gumbel Distribution is chosen for RFS over the Weibull Distribution. This addition enhances the technical clarity of the documentation.
5-5: Enhanced Explanation for Flow Duration Curves
The added details on Flow Duration Curves (FDCs), along with seasonal analyses, offer readers a richer context for water resource management. Ensure this description remains consistent with similar updates in related documents.docs/overview copy.md (1)
47-50: Typographical and Language Corrections in the Training Section
In the "River Forecast System Training" section, please update the following:
- Change “with out training” to “with our training”.
- Change “different sub sections” to “different subsections”.
Additionally, consider rephrasing “...with more information on how to download and use the RFS data...” to a more formal alternative.
Below is a suggested diff:-To learn more about our model, RFS, continue with out training under the River Forecast System portion of this website. +To learn more about our model, RFS, continue with our training under the River Forecast System portion of this website. - each having different sub sections within them. + each having different subsections within them. - as you are learning about the data, there is also a website available with more information on how to download and use the RFS data: https://data.geoglows.org/. + as you are learning about the data, there is also a website available with further details on downloading and using the RFS data: [Learn more about RFS data](https://data.geoglows.org/).This comment reiterates previous suggestions regarding typographical fixes.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: “out” (outside) seems less likely than “our” (belonging to us).
Context: ...ore about our model, RFS, continue with out training under the River Forecast Syste...(AI_HYDRA_LEO_CP_OUT_OUR)
[misspelling] ~48-~48: This word is normally spelled as one.
Context: ... 3 main sections, each having different sub sections within them. We recommend you start wit...(EN_COMPOUNDS_SUB_SECTIONS)
[style] ~48-~48: Consider using a more formal alternative.
Context: ... there is also a website available with more information on how to download and use the RFS data...(MORE_INFO)
docs/rfs/accessing_data/web-app.md (8)
5-6: Image Reference for HydroViewer is Clear.
The diagram image for the HydroViewer is correctly referenced and appears to be in order.
7-13: Stream Visualization Section is Well-Documented.
The section clearly explains the functionality of stream visualization and appropriately includes an image for the color-coded legend.
15-24: Map Features Section is Comprehensive.
The bullet list detailing zoom levels, interactive river selection, and direct river ID entry is well-structured. A quick review of formatting and punctuation for list items might help further polish the presentation.
27-32: Selecting Data Instructions are Clear.
The explanation for selecting data and opening the pop-up window is straightforward and user-friendly.
37-43: Previous Forecast Data Section is Well-Outlined.
The description of the default 15-day forecast and the option to select a previous day is clear and informative.
44-48: Retrospective Data Section is Informative.
This section effectively explains the availability of 10 years of retrospective data along with options for adjustments.
58-67: Filtering Data Section is Clear and Concise.
The filtering options and criteria (including river country, VPU number, and river outlet country) are clearly listed and easy to follow.
68-70: Map Filtering Description is Effective.
The final statement and accompanying image effectively communicate that only rivers meeting the filter criteria will be shown on the map.docs/index.md (2)
2-2: Updated Image Reference on Line 2
The image path "static/images/image3.png" is retained as a relative path. Verify that this is in line with the new static directory configuration for content delivery.
6-6: Addition of New Image on Line 6
A new image "static/images/img10.png" is added. This appears to replace navigational guidance formerly provided in the "Navigating the Website" section. Confirm that this visual update effectively supplements user guidance now available in other documentation sections.docs/rfs/accessing_data/data-catalog.md (3)
3-3: Enhanced Description for AWS Buckets
The updated text clearly explains that RFS provides direct access to global streamflow data via AWS S3, including both retrospective simulation and 15‐day forecasts. This improved clarity helps users understand the data sources.
7-7: Updated Image Path for Collab Notebooks
The image reference now uses a relative path ("../../static/images/image5.png"). Please verify that the file exists at this location and that it remains visually consistent with the overall documentation style.
21-21: Updated AWS Bucket Interface Image
The image on line 21 has been updated to reflect the new directory structure ("../../static/images/aws_bucket.png"). Ensure that this image correctly represents the current AWS interface for user downloads.docs/rfs/available_data/retrospective.md (1)
26-26: New Return Period Calculations Section
The newly added section clearly explains that return periods (2, 5, 10, 25, 50, and 100 years) are computed for each stream reach. This additional context is valuable for users assessing warning levels.docs/rfs/available_data/forecast.md (5)
3-3: Clear Introduction to Ensemble Forecasts
The updated text concisely explains that RFS produces ensemble streamflow forecasts using ECMWF data, with daily updates and units in cubic meters per second. This provides a straightforward overview for users.
12-12: Updated Forecast Example Image on Line 12
The image reference "" has been updated to reflect the new directory structure. Confirm that the image aligns with the accompanying explanation of ensemble forecasts.
15-17: Detailing Forecast Update Frequency and Resolution
The additional lines explain that the streamflow forecast is updated daily using a 24-hour mean and that ensemble members have a 9 km resolution. This enhancement improves clarity around forecast cadence and spatial resolution.
26-26: Detailed Description of Forecast Plot Summaries
The added explanation on line 26 regarding the median, 20th, and 80th percentiles effectively communicates how forecast plots should be interpreted. This clarification aids users in understanding ensemble uncertainty.
38-38: Forecast Plot Visualization on Line 38
The inclusion of the forecast plot image with the updated path ("../../static/images/img8.png") is effective. Please ensure that the image accurately represents the described elements (i.e., median, percentile values, and uncertainty regions).docs/rfs/accessing_data/data-service.md (4)
1-8: Introduction to the REST API Section
The new section introduces the GEOGLOWS ECMWF Streamflow Service for accessing streamflow data programmatically via a REST API. The description is thorough and provides clear guidance on supported formats (CSV/JSON). For consistency with other documentation that now uses "RFS," please verify that the naming ("GEOGLOWS ECMWF Streamflow Service") is intentional.
12-12: Instructions on River ID Requirement
The paragraph on line 12 explains the necessity of a 9-digit river ID (COMID/Link Number) for API calls. This is clear; just double-check that any external links (e.g., "Finding River Numbers") are updated to reflect the current data portal structure if applicable.
14-33: Step-by-Step Guide for Using the API Website
The detailed steps (from "Using the API Website" through the associated images) are well organized. They clearly instruct users on enabling input fields, entering parameters, and executing API requests. Confirm that the images ("api-window-pop-up.png", "execute-button.png", and "response-api.png") are current and align with the live interface.
35-43: Accessing the API with Python
The section “Accessing the API Using Python” provides useful information about a dedicated Python package and an example notebook. This addition is valuable for users preferring programmatic data access.docs/rfs/skills_examples/bias-correction.md (1)
27-27: Verify Image Path Update
The update of the image path for the SABER illustration to "../../static/images/saber.png" appears correct and aligns with the new documentation structure.docs/overview.md (3)
3-3: Image Path Update for Consistency
The updated image reference at line 3 now uses the designated static directory ("static/images/image3.png"), which ensures consistency across the documentation.
97-97: Validated Hydroviewer Image Path
The revised image path at line 97 ("static/images/hydroviewer.png") is correct and consistent with the new file organization.
116-116: Confirmed Image Update
The updated image at line 116 ("static/images/img8.png") looks correct and aligns with the intended documentation updates.docs/rfs/available_data/GIS-data.md (5)
9-9: Merged Lake Catchments Description is Clear
The description for merged lake catchments is sufficiently detailed. It clearly explains that lake catchments are derived from merged stream catchments and that their shapes may differ from actual lake boundaries.
15-15: VPUs Section is Informative
The updated VPUs description is clear and comprehensive. It effectively communicates that the GIS data is divided into 125 VPUs for better management. No further action is necessary here.
17-17: Image Path Update Verification
The image markdown now references a relative path (“../../static/images/vpu-boundary.png”). Ensure that this path correctly reflects the new directory structure on the website.
59-59: Confirm Removal of Small Watersheds
The statement “- Small watersheds that did not represent real flowing streams were often dropped.” is concise and clear regarding data processing. This change is acceptable as is.
34-34: Verify Attribute Naming Convention
The attribute “LengthGeodesucMaters” is presented as the geodesic length in meters; however, the term appears to be misspelled. Please verify if the intended name is “LengthGeodesicMeters.” If so, consider applying this diff:-**LengthGeodesucMaters** +**LengthGeodesicMeters**If “LengthGeodesucMaters” is the desired identifier per the project standards, please confirm its consistency across the codebase.
✅ Verification successful
I'm gathering the necessary information. I'll search the repository for both "LengthGeodesucMaters" and "LengthGeodesicMeters" to verify which term is consistently used.
🏁 Script executed:
#!/bin/bash echo "Searching for occurrences of 'LengthGeodesucMaters'..." rg "LengthGeodesucMaters" --color=never echo "------------------------------" echo "Searching for occurrences of 'LengthGeodesicMeters'..." rg "LengthGeodesicMeters" --color=neverLength of output: 513
Action Required: Correct the typo in the attribute name
After searching the repository, the term “LengthGeodesucMaters” only appears in docs/rfs/available_data/GIS-data.md, and there are no references to “LengthGeodesicMeters.” This suggests that “LengthGeodesucMaters” is likely a typo and should be corrected to “LengthGeodesicMeters” per standard naming conventions.
- Update the attribute in docs/rfs/available_data/GIS-data.md as follows:
-**LengthGeodesucMaters** +**LengthGeodesicMeters**
docs/overview.md
Outdated
|
|
||
| ### 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. | ||
|  | ||
|  |
There was a problem hiding this comment.
Image Path Anomaly Detected
The image reference at line 105, "static/images/api.pngimg9.png", appears to be a concatenation error. Please verify whether the intended filename is "api.png" or "img9.png" to ensure the correct image is displayed.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (16)
docs/rfs/skills_examples/bias-correction.md (2)
3-3: Simplify Language and Use Active Voice
In this paragraph, consider rephrasing "their observed data is able to be used to improve the modeled data at their location" to a more direct form such as "their observed data can be used to improve the modeled data at their location." This change addresses the LanguageTool suggestions regarding the passive voice and overly wordy phrasing.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... they can know that their observed data is able to be used to improve the modeled data at ...(BE_ABLE_TO)
[style] ~3-~3: Avoid the passive voice after ‘to be able to’.
Context: ...now that their observed data is able to be used to improve the modeled data at their lo...(ABLE_TO_PASSIVE)
21-21: Ensure Consistent Branding Terminology
While the earlier sections correctly refer to "RFS," this paragraph still mentions the "GEOGLOWS team." For consistency in branding and to avoid confusion, consider updating "GEOGLOWS team" to "RFS team" (or the appropriate term) if that aligns with the intended changes in the documentation.docs/overview.md (3)
34-34: Clarity in Model Contribution Description
The added sentence in line 34 explains that forecasting services contributed to the creation of RFS; however, consider rephrasing “in the creation of” to “in developing” or “in building” for improved clarity.
46-47: Refine Training Section Wording
In the “River Forecast System Training” section, the sentence “...broken down into 3 main sections, each having different sub sections within them” would read more professionally if revised to something like “divided into three main sections, each comprising distinct subsections”. This change also addresses the static analysis hint regarding the spelling of “subsections”.🧰 Tools
🪛 LanguageTool
[misspelling] ~47-~47: This word is normally spelled as one.
Context: ... 3 main sections, each having different sub sections within them. We recommend you start wit...(EN_COMPOUNDS_SUB_SECTIONS)
[style] ~47-~47: Consider using a more formal alternative.
Context: ... there is also a website available with more information on how to download and use the RFS data...(MORE_INFO)
49-49: Style Suggestion: Number Representation
Consider writing numbers in words for improved readability (e.g., “three main sections” instead of “3 sections”).docs/old_pages/overview.md (11)
3-3: Improve Image Accessibility.
The image markdown “” currently uses a generic alt text “image.” Consider updating it to a more descriptive alternative (e.g., “GEOGLOWS initiative overview”) to enhance accessibility.
22-23: Refine Descriptive Wording.
The sentence “The presentation linked below provides deeper insights into the scope and impact of GEOGLOWS” could be strengthened by replacing “deeper insights” with a phrase such as “comprehensive insights.”🧰 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)
25-25: Review External Presentation Link.
Given the PR objective to shift from external PDF/PowerPoint content to integrated website content, verify whether the “[GEOGLOWS V2 Overview]” link is still needed or if its content should be embedded directly on the site.
49-50: Refine History Narrative.
On the line “The presentation below offers a deeper insight into the history and impact of GEOGLOWS,” consider swapping “deeper insight” for “comprehensive insight” to further reinforce the narrative.🧰 Tools
🪛 LanguageTool
[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)
54-60: Technical Detail in Model Formulation.
The “## Model Formulation” section effectively explains the computation methods and technical background. For improved readability, consider changing “deeper insight” (line 57) to “comprehensive understanding” or a similar alternative.🧰 Tools
🪛 LanguageTool
[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)
85-98: Enhance Map Section Details.
In the “### Map” section, consider refining the hyperlink text. Instead of displaying the raw URL (or a generic link title), using descriptive text can better guide the user. In addition, update the image alt text to provide a clearer description of what the image represents.
99-106: Improve Retrospective Data Image Alt Text.
The “### Retrospective Data” section is informative; however, the image uses a generic alt text. To improve accessibility, update the alt text with a descriptive phrase that reflects the visual content (e.g., “Retrospective simulation data chart”).
107-117: Forecasts Section Review.
The “### Forecasts” section clearly outlines the characteristics of the forecast simulation, including ensemble details and time intervals. To further enhance accessibility, consider providing a more descriptive alt text for the forecast image.
118-133: Stories of Application Impact.
The “## Stories of Application” section effectively communicates the real-world benefits and impact of GEOGLOWS. To further engage readers, consider supplementing the text with additional visuals or links where available.
134-136: Reevaluate Presentation Link.
The “[Stories Presentation]” link currently points to external content. In line with the new web-centric approach and removal of legacy presentation formats, assess whether this link should be removed, replaced, or its content directly integrated onto the website.
138-150: Enhance Community Invitation.
The “## Joining GEOGLOWS” section is clear and welcoming. To further boost engagement, consider including a brief note on the benefits of joining the GEOGLOWS community or highlighting examples of collaborative success stories.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/old_pages/overview.md(1 hunks)docs/overview.md(3 hunks)docs/rfs/skills_examples/bias-correction.md(2 hunks)mkdocs.yml(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- mkdocs.yml
🧰 Additional context used
🪛 LanguageTool
docs/old_pages/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)
docs/overview.md
[misspelling] ~47-~47: This word is normally spelled as one.
Context: ... 3 main sections, each having different sub sections within them. We recommend you start wit...
(EN_COMPOUNDS_SUB_SECTIONS)
[style] ~47-~47: Consider using a more formal alternative.
Context: ... there is also a website available with more information on how to download and use the RFS data...
(MORE_INFO)
[uncategorized] ~52-~52: “out” (outside) seems less likely than “our” (belonging to us).
Context: ...ver Discharge** - This section explains out daily streamflow forecasts with 51 ense...
(AI_HYDRA_LEO_CP_OUT_OUR)
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...s section explains out daily streamflow forecasts with 51 ensembles providing predictions...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/rfs/skills_examples/bias-correction.md
[style] ~3-~3: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... they can know that their observed data is able to be used to improve the modeled data at ...
(BE_ABLE_TO)
[style] ~3-~3: Avoid the passive voice after ‘to be able to’.
Context: ...now that their observed data is able to be used to improve the modeled data at their lo...
(ABLE_TO_PASSIVE)
[style] ~7-~7: Try using a synonym here to strengthen your writing.
Context: ...Hydrologic Model has been validated and gives details of the methods of the bias-corr...
(GIVE_PROVIDE)
🔇 Additional comments (19)
docs/rfs/skills_examples/bias-correction.md (2)
27-27: Confirm Correctness of the Image Relative Path
The image path has been updated to "../../static/images/saber.png". Please verify that this relative path is correct given the location of the markdown file and that it reliably resolves to the desired image asset in the current directory structure.
9-9: 🛠️ Refactor suggestionReview PDF Link Consistency with PR Objectives
The link text still references a PDF ("[GEOGLOWS - Bias Correction.pdf]"), which might contradict the PR title "No pdf" and the documented shift toward directly integrated web content. Please verify whether this link should be removed, updated to a web-hosted presentation, or otherwise aligned with the new content delivery approach.docs/overview.md (13)
3-3: Image Path Update: Corrected Image Reference
The image reference now points to "static/images/image3.png", aligning with the revised asset directory structure.
11-13: Enhanced RFS Description: Expanded Overview of Capabilities
The updated text clearly emphasizes that RFS provides streamflow time series data for over 6 million river segments and makes historical and forecast data easily accessible. Please verify that this enhanced description remains consistent with other documentation files.
50-50: Clear Description for GIS Data Section
The explanation for the GIS Data section is clear and provides sufficient detail about the data used in RFS.
51-51: Retrospective River Discharge Section is Informative
The description mentioning “over 85 years of daily average streamflow data” offers clear insight into the dataset.
54-54: Accessing Data Section: Clear and Consistent
The updated description clearly outlines that the data can be accessed through four different techniques. Verify that each listed technique accurately reflects the implementation on the website.
55-55: Data Catalog Section is Concise
The explanation regarding the AWS-based data catalog is concise and clear.
56-56: REST API Data Service Clarification
The section effectively describes the use of the REST API to access GEOGLOWS data.
57-57: Web Map Information Well Articulated
The description of the Esri Living Atlas map layer is clear and provides the required context for GIS software integration.
58-58: HydroViewer Introduction is Clear
The introduction to the HydroViewer web application is well-described, outlining its purpose for data visualization and download.
60-60: Skills and Examples Section Introduced Effectively
The section on advanced techniques is introduced in a clear manner, setting up the reader for more detailed examples.
61-61: Colab Notebooks for Data Interpretation
The reference to Google Colab notebooks provides a practical, hands-on component for learning how to work with the GEOGLOWS Python package.
62-62: Bias Correction Overview is Sufficient
The brief explanation of bias correction and the SABER technique gives readers a proper introduction to these concepts.
63-63: Forecast Data Bias Correction Notebooks
The description accurately explains that a dedicated notebook is provided for bias correction examples related to forecast data.docs/old_pages/overview.md (4)
1-1: Header Clarity.
The title “# What is GEOGLOWS?” succinctly introduces the document and sets the stage for the content that follows.
5-21: Overview Section Content.
The “## Overview” section comprehensively explains the purpose and scope of GEOGLOWS. The content is engaging and informative.
27-48: History Section Clarity.
The “## History” section clearly narrates the evolution and background of GEOGLOWS. The structure and level of detail help set the context effectively.
61-83: Clear Data Description.
The “## Understanding GEOGLOWS Data” section offers a thorough explanation of the data services and methodologies. The details are well presented.
| The GEOGLOWS model leverages the Hydrology Tiled ECMWF Scheme for Surface Exchanges over Land (HTESSEL) alongside the ECMWF Integrated Forecast System (IFS) to conduct detailed calculations of water and energy balances within grid cells. HTESSEL simulates how land surfaces respond to atmospheric conditions, estimating critical variables such as surface and sub-surface runoff for both operational ensemble forecasts and retrospective simulations. The model employs varying spatial resolutions for its runoff files, including approximately 25 km for historical ERA-5 data, 16 km for low-resolution ensemble members, and 8 km for high-resolution forecasts. By intersecting grid lines with specific basins and applying runoff depth values, the model calculates water volumes over different time periods, which are then routed through the stream network using the Muskingum method with the RAPID algorithm. This approach provides valuable discharge data for hydrological analysis and decision-making. | ||
|
|
||
| The presentation below offers a deeper insight into the model formulation of the GEOGLOWS Model. | ||
| The GEOGLOWS model leverages the Hydrology Tiled ECMWF Scheme for Surface Exchanges over Land (HTESSEL) and the ECMWF Integrated Forecast System (IFS) to as the runoff data input for the hydrologic streamflow model. HTESSEL simulates how land surfaces respond to atmospheric conditions, estimating critical variables such as surface and sub-surface runoff for both operational ensemble forecasts and retrospective simulations. We intersect grid lines with specific basins of RFS and apply runoff depth values, to calculate water volumes over different time periods. These are routed through the stream network using the Muskingum method with the RAPID algorithm. We report the discharge values at each of the stream segments. For more information on the model itself, please see the publication page where there are links to the academic publications explaining the model |
There was a problem hiding this comment.
Typographical Issue in Model Formulation
The phrase “to as the runoff data input” appears awkward. A suggested revision is to change it to “serves as the runoff data input” or “acts as the runoff data input”.
| 1. **Available Data** - This section details the available datasets from RFS. It is divided into 3 sections: | ||
| - **a. GIS Data** - This section explains the hydrography data used in the RFS, including stream centerlines, catchment boundaries, and their unique identifiers, derived from high-resolution elevation products. | ||
| - **b. Retrospective River Discharge** - In this section, we describe over 85 years of daily average streamflow data, derived from meteorological reanalysis and updated weekly. | ||
| - **c. Forecast River Discharge** - This section explains out daily streamflow forecasts with 51 ensembles providing predictions at 3-hour intervals. |
There was a problem hiding this comment.
Typographical Correction in Forecast Data Section
The text “explains out daily streamflow forecasts” should be corrected to “explains our daily streamflow forecasts”. Additionally, for clarity consider inserting a comma after “forecasts” (e.g., “explains our daily streamflow forecasts, with 51 ensembles providing predictions at 3‑hour intervals”).
🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: “out” (outside) seems less likely than “our” (belonging to us).
Context: ...ver Discharge** - This section explains out daily streamflow forecasts with 51 ense...
(AI_HYDRA_LEO_CP_OUT_OUR)
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...s section explains out daily streamflow forecasts with 51 ensembles providing predictions...
(AI_HYDRA_LEO_MISSING_COMMA)
Much of the content was removed from powerpoints and set to be directly in the website
Summary by CodeRabbit
New Features
• Added interactive, step‑by‑step guides for API usage and streamflow data exploration.
• Introduced new sections detailing return period calculations and available publications.
Documentation
• Expanded and clarified instructions for accessing real‑time and historical streamflow data through the HydroViewer.
• Enhanced content clarity on dataset update frequencies and data visualization, with streamlined navigation for an improved user experience.