Skip to content

Commit

Permalink
docs more cleanup and broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
philipbaileynar committed Jan 19, 2024
1 parent 5e23ead commit 028b318
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 8 deletions.
6 changes: 6 additions & 0 deletions docs/Online_Help/Sandbars/sd_sample.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ The stage discharge tab contains several elements:

You can calculate the stage for any particular discharge using the calculator at the top of this form. Ensure you have picked the correct stage discharge curve from the dropdown and then enter a discharge value. The stage will be calculated using the selected relationship.

## Managing Stage Discharge Curves

Stage discharge curves are managed directly by editing the Workbench SQLite database. Open the database using your preferred database software such as [SQLite Studio](https://sqlitestudio.pl/), [DB Browser](https://sqlitebrowser.org/) or [DataGrip](https://www.jetbrains.com/datagrip).

Open the table called [StageDischargeParams](/Technical_Reference/database_object_model.html#stagedischargeparams). Filter to desired site and the add, edit or delete records as necessary.

## Video Demonstration

<iframe width="100%" height="500" src="https://www.youtube.com/embed/iVCHKBjzblQ?si=3wfGRSIN8MY" title="YouTube video player" frameborder="0" allowfullscreen></iframe>
4 changes: 2 additions & 2 deletions docs/Online_Help/Views/Managing-Reference-Information.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Deleting items is permanent and cannot be undone!

## Analysis Bins

Analysis bins represent the vertical bins that are used in the [binned sandbar analysis](/technical_reference/binned_analysis). They are editable and so the next time the sandbar analysis is performed it will include all the bins currently defined in the local database. Note that deleting an analysis bin will also delete the results for all historical sandbar analyses stored in the local database! Therefore, rather than deleting an analysis bin, it is recommended that you deactivate it by unchecking the checkbox on the properties form (see below).
Analysis bins represent the vertical bins that are used in the [binned sandbar analysis](/Technical_Reference/sandbar_analysis_intro.html#6-binned-analysis)). They are editable and so the next time the sandbar analysis is performed it will include all the bins currently defined in the local database. Note that deleting an analysis bin will also delete the results for all historical sandbar analyses stored in the local database! Therefore, rather than deleting an analysis bin, it is recommended that you deactivate it by unchecking the checkbox on the properties form (see below).

![analysis bins](/images/views/analysis_bins.png)

## Campsite Analysis Bins

These bins are similar to the Analysis Bins above, but are exclusively used for the campsite analysis. The same rules apply to campsite analysis bins.
These bins are similar to the Analysis Bins above, but are exclusively used for the [campsite analysis](/Technical_Reference/sandbar_analysis_intro.html#7-campsite-analysis). The same rules apply to campsite analysis bins.

## Reaches

Expand Down
10 changes: 5 additions & 5 deletions docs/Technical_Reference/database_object_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,11 @@ This table stores the results of the sandbar **campsite** analysis.

| Field | Info | Description |
| ------------ | -------------- | ----------- |
| RunID | INTEGER, NN, **PK** | |
| SurveyID | INTEGER, NN, FK | |
| BinID | INTEGER, NN, FK | |
| CampsiteShapeFile | TEXT | |
| Area | REAL | |
| RunID | INTEGER, NN, **PK** | Model Run. |
| SurveyID | INTEGER, NN, FK | Sandbar Survey. |
| BinID | INTEGER, NN, FK | Campsite Analysis Bin. |
| CampsiteShapeFile | TEXT | This field is not actually used. It was originally intended to store the name of the campsite ShapeFile used for this analysis.|
| Area | REAL | Area, in m², of the campsite for the specific elevation bin during the specified survey.|

## ModelResultsIncremental

Expand Down
2 changes: 1 addition & 1 deletion docs/Technical_Reference/interpolation_methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 3

# Raster Interpolation

***NB: There is currently [a bug (Github Issue #2)](https://github.com/NorthArrowResearch/sandbar-analysis/issues/2) to do with raster interpolations methods. The following will only apply after this bug has been fixed.***
***NB: There is currently a bug to do with raster interpolations methods. The following will only apply after this bug has been fixed.***

There are 4 resampling methods available to the user in the sandbar analysis:

Expand Down
14 changes: 14 additions & 0 deletions docs/Technical_Reference/sandbar_analysis_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,22 @@ The binned analysis is somewhat simpler than the incremental analysis. The same
* Between 8,000 and 25,000 CFS
* Above 25,000 CFS.


The analysis measures the area and volume of sand in each bin, excluding the minimum surface. The resultant areas and volumes are written to a CSV text file next to that of the incremental analysis.

## 7. Campsite Analysis

The campsite analysis includes the following steps.

1. The [campsite polylines](/Online_Help/Sandbar_Analysis/campsites.html) are first converted to polygons.


1. The [campsite polylines](/Online_Help/Sandbar_Analysis/campsites.html) are converted to 3D points and merged with the regularly spaced corgrids survey points.
2. This new "merged" point dataset is converted to raster using [gdal_grid](https://gdal.org/programs/gdal_grid.html) with the same cell resolution as is used in the incremental and binned analyses.
3. This raster is then clipped to the campsite areas using [gdal warp](https://gdal.org/programs/gdalwarp.html) with the digitized campsite polylines converted to polygons acting as the clipping mask.
4. The area of each campsite is calculated for each elevation bin in much the same way as the regular binned analysis, albeit using [different bins](/Online_Help/Views/Managing-Reference-Information.html#campsite-analysis-bins) that are exclusively intended for the campsite analysis.
5. The results are written to CSV file and then inserted into the Workbench database in the table called [ModelResultsCampsites](/Technical_Reference/database_object_model.html#modelresultscampsites).

## Video Demonstration

The following video demonstration walks through the input and output files produced by the sandbar analysis. It describes the folder and file structure used and how to interpret the results.
Expand Down

0 comments on commit 028b318

Please sign in to comment.