diff --git a/frontend/rctool/templates/rctool/rctool/import/rctool_import.html b/frontend/rctool/templates/rctool/rctool/import/rctool_import.html index 25414d2e..c16662f5 100644 --- a/frontend/rctool/templates/rctool/rctool/import/rctool_import.html +++ b/frontend/rctool/templates/rctool/rctool/import/rctool_import.html @@ -84,7 +84,7 @@
- If no uncertainty data is provided, missing values will be filled in as 0.05 (5%). + If no uncertainty data is provided, missing values will be filled in as 0.1 (10%).
@@ -184,7 +184,7 @@
  • +
  • +
  • +
  • +
  • +
  • -
    -
    Let's Get Started
    - - Hydrometric field work involves regular visits to a hydrometric gauging station across a range of streamflow conditions. A hydrometric gauging station typically consists of a stage sensor and benchmarks or reference gauge from which water level is referenced. Each field visit should collect three basic observations: reference of stage, measurement of discharge, and control observation. These observations are required to convert stage into discharge through the development of a hydrometric rating curve. (Note: Safety should be considered when collecting these observations, do not attempt any unsafe field work!). -

    The Hydrometric Rating Application (HydRA) is a tool for developing hydrometric rating curves based on observations of stage and discharge. HydRA allows the user to upload observations of stage and discharge and automatically fits a rating curve. Users can adjust the fit according to onsite observations. It then generates a rating equation that can be used for converting stage datasets into discharge. -     -
    - -
    -
    -
    -
    Uploading Data
    - - Users may input their hydrometric observations by uploading a .csv file. Use the comments section to indicate meta-data such as measurement quality or control condition. HydRA will plot all stage and discharge observations and then automatically fit a rating curve using the rating equation. - -
    - -
    -
    - -
    -
    -
    -
    -
    The Rating Equation
    - Stage-discharge ratings are generally based on Manning's simplified hydraulic equation below where Q is - discharge - , H is - stage - , h0 is the - offset - , C is the - coefficient - , and b is the - exponent. -
    -
    - Q = C ( H - h0 ) b -
    -
    - h0 - offset: - Gauge height at zero flow. This is typically set by the user as the height of the bed.
    - C - coefficient: - Calibration parameter influenced by channel characteristics such as width, slope, bed roughness.
    - b - exponent: - Calibration parameter influenced by the control geometry. - Controls - are natural or constructed features located downstream of the gauge which influence flow. -
    -
    -
    -
    Time for a Break
    - Stage-discharge relations may have multiple rating - segments - divided by - breakpoints - - . Each segment is a rating equation governed by unique hydraulic controls. - In the example figure below, segment 1 applies to stage between 0.32 m and 0.52 m and is likely influenced by section controls such as channel constrictions, woody debris, or rock ledges. Segment 2 applies to stage values between 0.52 m and 1.4 m and is likely affected by channel - controls such as channel geometry and bed roughness. - -
    - -
    -
    -
    -
    Performance
    -
    - The HydRa app offers the option to auto-fit rating curves by finding the best equation describing the uploaded field data. This is done by calculating common metrics used to assess the performance of hydrometric rating curves: -
    -
    - Root Mean Square Error
    - The root mean square error (RMSE) is given by the equation below where Q is discharge and N is number of measurements. This provides an indication of the average error between observed and predicted discharge values. -
    -
    - -
    -
    - Percent Error
    - Percent error is calculated by the following equation where Q is discharge and an example is shown by the figure below. This plot is useful for analyzing the error distribution and identifying outliers. -
    -
    - -
    -
    - -
    -
    -
    -
    -
    -
    Data Review
    - HydRA is designed to ONLY produce a rating curve equation and summary report. The complete hydrometric data review process should include the review, correction, and grading of the input stage dataset and the output discharge dataset according to the 2018 BC Hydrometric RISC standards -

    Applying RISC grades to the output discharge dataset may depend on the performance of the rating equation in predicting discharge or the range of discharge observed during the rating period. All hydrometric data should be reviewed and graded by a qualified professional according to the RISC standards. For more information, consult RISC Table 1-1.     -
    - -
    -
    -
    -
    -
    -
    Overview Complete
    - All done! Proceed to a walkthrough of the HydRA platform from importing stage-discharge data to development, optimization, saving and exporting a session. Navigate with the arrows to revisit any topics previously covered. -
    -
    - - Please provide any feedback about the use of the tool here! - The link is also displayed in the footer of all pages. - -
    - -
    -
    + {% include 'rctool/rctool/tour/slide1.html' %} + {% include 'rctool/rctool/tour/slide2.html' %} + {% include 'rctool/rctool/tour/slide3.html' %} + {% include 'rctool/rctool/tour/slide4.html' %} + {% include 'rctool/rctool/tour/slide5.html' %} + {% include 'rctool/rctool/tour/slide6.html' %} + {% include 'rctool/rctool/tour/slide7.html' %} + {% include 'rctool/rctool/tour/slide8.html' %} + {% include 'rctool/rctool/tour/slide9.html' %} +
    diff --git a/frontend/rctool/templates/rctool/rctool/tour/slide1.html b/frontend/rctool/templates/rctool/rctool/tour/slide1.html new file mode 100644 index 00000000..3b147eb0 --- /dev/null +++ b/frontend/rctool/templates/rctool/rctool/tour/slide1.html @@ -0,0 +1,12 @@ +{% load static %} + +
    +
    Let's Get Started
    + + Hydrometric field work involves regular visits to a hydrometric gauging station across a range of streamflow conditions. A hydrometric gauging station typically consists of a stage sensor and benchmarks or reference gauge from which water level is referenced. Each field visit should collect three basic observations: reference of stage, measurement of discharge, and control observation. These observations are required to convert stage into discharge through the development of a hydrometric rating curve. (Note: Safety should be considered when collecting these observations, do not attempt any unsafe field work!). +

    The Hydrometric Rating Application (HydRA) is a tool for developing hydrometric rating curves based on observations of stage and discharge. HydRA allows the user to upload observations of stage and discharge and automatically fits a rating curve. Users can adjust the fit according to onsite observations. It then generates a rating equation that can be used for converting stage datasets into discharge. +     +
    + +
    +
    \ No newline at end of file diff --git a/frontend/rctool/templates/rctool/rctool/tour/slide2.html b/frontend/rctool/templates/rctool/rctool/tour/slide2.html new file mode 100644 index 00000000..1397c0b6 --- /dev/null +++ b/frontend/rctool/templates/rctool/rctool/tour/slide2.html @@ -0,0 +1,17 @@ +{% load static %} + +
    +
    Uploading Data
    + + Users may input their hydrometric observations by uploading a .csv file. + Use the comments section to indicate meta-data such as measurement quality or control condition. + If the uncertainty field is left blank, HydRA assumes discharge measurement uncertainty of 10%. + HydRA will plot all stage and discharge observations and then automatically fit a rating curve using the rating equation. + +
    + +
    +
    + +
    +
    \ No newline at end of file diff --git a/frontend/rctool/templates/rctool/rctool/tour/slide3.html b/frontend/rctool/templates/rctool/rctool/tour/slide3.html new file mode 100644 index 00000000..14693eb9 --- /dev/null +++ b/frontend/rctool/templates/rctool/rctool/tour/slide3.html @@ -0,0 +1,30 @@ +{% load static %} + +
    +
    +
    The Rating Equation
    + Stage-discharge ratings are generally based on Manning's simplified hydraulic equation below where Q is +     discharge + , H is + stage + , h0 is the + offset + , C is the + coefficient + , and b is the + exponent. +
    +
    + Q = C ( H - h0 ) b +
    +
    + h0 - offset: + Gauge height at zero flow. This is typically set by the user as the height of the bed.
    + C - coefficient: + Calibration parameter influenced by channel characteristics such as width, slope, bed roughness.
    + b - exponent: + Calibration parameter influenced by the control geometry. + Controls + are natural or constructed features located downstream of the gauge which influence flow. +
    +
    \ No newline at end of file diff --git a/frontend/rctool/templates/rctool/rctool/tour/slide4.html b/frontend/rctool/templates/rctool/rctool/tour/slide4.html new file mode 100644 index 00000000..48a3567e --- /dev/null +++ b/frontend/rctool/templates/rctool/rctool/tour/slide4.html @@ -0,0 +1,20 @@ +{% load static %} + + +
    +
    Fit for a Stream
    + + The HydRA app offers the option to auto-fit rating curves by finding the best equation describing the uploaded field data. The auto-fit function uses a power law model with weights based on discharge measurement uncertainty. A least square method is used to define the auto-fit, this fit may be optimized by adjusting applicable measurements or offsets. + +
    + + The uncertainty for each discharge measurement is used to weigh the importance of each measurement in the fit. + Implementation details of the power law model can be found in the open source code of HydRA + and the documentation for the lmfit library and its + weights. + + +
    + +
    +
    \ No newline at end of file diff --git a/frontend/rctool/templates/rctool/rctool/tour/slide5.html b/frontend/rctool/templates/rctool/rctool/tour/slide5.html new file mode 100644 index 00000000..680a45a7 --- /dev/null +++ b/frontend/rctool/templates/rctool/rctool/tour/slide5.html @@ -0,0 +1,43 @@ +{% load static %} + + +
    +
    To Fit and to Fiddle
    +
    + + Common metrics can be used to assess the performance of your hydrometric rating curve. These include the following: + +
    +
    + Root Mean Square Error
    + + The Root Mean Square Error (RMSE) is given by the equation below where Q is discharge and N is number of measurements. + This provides an indication of the average error between observed and predicted discharge values.
    + In general, a lower RMSE means a better “fit” of the dataset. + HydRA auto-fits the rating curve parameters to, in part, minimize the RMSE. However, there are many sources of uncertainty in hydrometric data and many ways to adjust the “fit” of a rating curve. + Multiple rating curve parameter interpretations may be compared using the RMSE to assess which is the best fit. +     +
    +
    + +
    +
    + Percent Error
    + Percent error is calculated by the following equation where Q is discharge and an example is shown by the figure below. This plot is useful for analyzing the error distribution and identifying outliers. +
    +
    + +
    +
    + +
    +
    + Mean Average Percentage Error
    + + The Mean Average Percentage Error (MAPE) is calculated similarly to the Percent Error, but averaged over all observed values. + +
    + +
    +
    +
    \ No newline at end of file diff --git a/frontend/rctool/templates/rctool/rctool/tour/slide6.html b/frontend/rctool/templates/rctool/rctool/tour/slide6.html new file mode 100644 index 00000000..954190d6 --- /dev/null +++ b/frontend/rctool/templates/rctool/rctool/tour/slide6.html @@ -0,0 +1,18 @@ +{% load static %} + + +
    +
    Time for a Break
    + Stage-discharge relations may have multiple rating + segments + divided by + breakpoints + + . Each segment is a rating equation governed by unique hydraulic controls. + In the example figure below, segment 1 applies to stage between 0.32 m and 0.52 m and is likely influenced by section controls such as channel constrictions, woody debris, or rock ledges. Segment 2 applies to stage values between 0.52 m and 1.4 m and is likely affected by channel + controls such as channel geometry and bed roughness. + +
    + +
    +
    \ No newline at end of file diff --git a/frontend/rctool/templates/rctool/rctool/tour/slide7.html b/frontend/rctool/templates/rctool/rctool/tour/slide7.html new file mode 100644 index 00000000..5ee5a680 --- /dev/null +++ b/frontend/rctool/templates/rctool/rctool/tour/slide7.html @@ -0,0 +1,38 @@ +{% load static %} + + +
    +
    If the curve fits, use it
    +

    + + Step 1: + Upload field visit information for your period of interest including all relevant fields + +

    +

    + + Step 2: + Input the offset as the gauge height, or stage, at zero flow + +

    +

    + + Step 3: + Assess the quality of the auto-fit by adjusting curve parameters such as: end points, applicable measurements, offsets. Consult field visit notes, photos and discharge measurement meta-data to assess further. If applicable, add any breakpoints to account for channel complexity at higher or lower stages. Consider comparing multiple interpretations of the fit using the RMSE and MAPE parameters +
    + *Note: this may take some time, session settings can be saved in the export tab +     +

    +

    + + Step 4: + Export rating curve parameters as a .pdf or .csv + +

    +

    + + Step 5: + Use input values of stage with your rating curve equation to produce modelled discharge, remember to grade your output dataset according to provincial hydrometric RISC standards + +

    +
    \ No newline at end of file diff --git a/frontend/rctool/templates/rctool/rctool/tour/slide8.html b/frontend/rctool/templates/rctool/rctool/tour/slide8.html new file mode 100644 index 00000000..1b19a4a8 --- /dev/null +++ b/frontend/rctool/templates/rctool/rctool/tour/slide8.html @@ -0,0 +1,14 @@ +{% load static %} + +
    +
    +
    +
    Data Review
    + HydRA is designed to ONLY produce a rating curve equation and summary report. The complete hydrometric data review process should include the review, correction, and grading of the input stage dataset and the output discharge dataset according to the 2018 BC Hydrometric RISC standards +

    Applying RISC grades to the output discharge dataset may depend on the performance of the rating equation in predicting discharge or the range of discharge observed during the rating period. All hydrometric data should be reviewed and graded by a qualified professional according to the RISC standards. For more information, consult RISC Table 1-1.     +
    +
    + Get Started +
    +
    +
    \ No newline at end of file diff --git a/frontend/rctool/templates/rctool/rctool/tour/slide9.html b/frontend/rctool/templates/rctool/rctool/tour/slide9.html new file mode 100644 index 00000000..4f0ad9a6 --- /dev/null +++ b/frontend/rctool/templates/rctool/rctool/tour/slide9.html @@ -0,0 +1,20 @@ +{% load static %} + + +
    +
    +
    +
    Overview Complete
    + All done! Proceed to a walkthrough of the HydRA platform from importing stage-discharge data to development, optimization, saving and exporting a session. Navigate with the arrows to revisit any topics previously covered. +
    +
    + + Please provide any feedback about the use of the tool here! + The link is also displayed in the footer of all pages. + +
    +
    + Get Started +
    +
    +
    \ No newline at end of file diff --git a/frontend/rctool/views.py b/frontend/rctool/views.py index 7560ee15..dbed640e 100644 --- a/frontend/rctool/views.py +++ b/frontend/rctool/views.py @@ -436,8 +436,8 @@ def rctool_develop_initialize(request): # fill in missing uncertainty values if "uncertainty" not in field_df_raw: - field_df_raw["uncertainty"] = 0.05 - field_df_raw.fillna({"uncertainty": 0.05}, inplace=True) + field_df_raw["uncertainty"] = 0.10 + field_df_raw.fillna({"uncertainty": 0.10}, inplace=True) field_df_raw["uncertainty"] = field_df_raw["uncertainty"].round(decimals=3) field_df_raw["datetime"] = field_df_raw["datetime"].apply(str) diff --git a/frontend/static/images/MAPE.png b/frontend/static/images/MAPE.png new file mode 100644 index 00000000..fdfda3a8 Binary files /dev/null and b/frontend/static/images/MAPE.png differ diff --git a/frontend/static/images/QPE.png b/frontend/static/images/QPE.png new file mode 100644 index 00000000..e73445eb Binary files /dev/null and b/frontend/static/images/QPE.png differ diff --git a/frontend/static/images/RMSE.JPG b/frontend/static/images/RMSE.JPG deleted file mode 100644 index 80a5c9ff..00000000 Binary files a/frontend/static/images/RMSE.JPG and /dev/null differ diff --git a/frontend/static/images/RMSE.png b/frontend/static/images/RMSE.png index 6ca30779..f96e0622 100644 Binary files a/frontend/static/images/RMSE.png and b/frontend/static/images/RMSE.png differ diff --git a/frontend/static/images/error_percent.JPG b/frontend/static/images/error_percent.JPG deleted file mode 100644 index 0dbcd77a..00000000 Binary files a/frontend/static/images/error_percent.JPG and /dev/null differ