Skip to content

Commit

Permalink
more docs and images
Browse files Browse the repository at this point in the history
  • Loading branch information
philipbaileynar committed Dec 14, 2023
1 parent 12fd1b1 commit 4d87dc0
Show file tree
Hide file tree
Showing 17 changed files with 46 additions and 12 deletions.
1 change: 1 addition & 0 deletions docs/content/page/about/acknowledgements.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Acknowledgements
banner: true
description: Acknowleding the funders and developers of QRiS
---

QGIS Riverscapes Studio or QRiS (pronounced curious) is a flagship, professional-grade tool of the [Riverscapes Consortium](http://riverscapes.net). The free, [open-source software](https://github.com/Riverscapes/QRiS) is a [plugin](https://plugins.qgis.org/) to the free, open-source [QGIS](https://plugins.qgis.org/) software. The tool is targeted at anyone interested in understanding and analyzing their riverscape - including: practitioners, managers, analysts, researchers and students with some familiarity with GIS. It helps users with analysis, monitoring, assessment of riverscapes as well as preparation of the design and as-builts of [low-tech process-based restoration designs](http://lowtechpbr.restoration.usu.edu/resources/Topics/04_Design/).
Expand Down
1 change: 1 addition & 0 deletions docs/content/page/about/license.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: License & Source Code
banner: true
description: QRiS is open source and free to use
---

The QGIS Riverscapes Studio (QRiS) is:
Expand Down
1 change: 1 addition & 0 deletions docs/content/page/download/install.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Install QRiS
banner: true
description: QRiS installation process
---

## Install Plugin From Q Plugin Library
Expand Down
4 changes: 4 additions & 0 deletions docs/content/page/software-help/aoi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,14 @@ Areas of Interest are polygon feature classes that can be used to clip other lay

You can have as many AOIs within your project as you like. And each AOI can have multiple polygon features.

![AOI overview](/images/software-help/aoi-overview.png)

## Add an Existing AOI

You can import an existing polygon feature class and use it as an AOI. To do this, click the **Add Existing AOI** button on the **Areas of Interest** folder within your QRiS [project](/software-help/project). Browse to the location of the polygon feature class and click **Open**. Provide a name and optional description for the AOI. You can also define key/value pairs of metadata that help describe the originof the data. Click **OK** to import and create a copy of the feature class will be added to your project and will be available for use when importing other data.

![create aoi](/images/software-help/create-aoi.png)

## Create a New AOI

You can create a new AOI by drawing a polygon on the map. To do this, click the **Create New AOI** button on the **Areas of Interest** folder within your QRiS [project](/software-help/project). Provide a name and optional description and then click **OK**. Add the AOI to the map by clicking the **Add to Map** button. You can now use the standard QGIS editing tools to digitize the AOI on the map. Remember to stop editing and save your changes before the AOI is available for use when importing other data.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/page/software-help/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Clicking the QRiS icon on the left side of the QRiS toolbar will hide and show t

## Create a New Project

To create a new project, click the **Project** button and then **Create New Project** on the QRiS toolbar. This will open the **New QRiS Project** dialog. See [Creating a New Project](/software-help/creating-a-new-project) for more information.
To create a new project, click the **Project** button and then **Create New Project** on the QRiS toolbar. This will open the **New QRiS Project** dialog. See [Creating a New Project](/software-help/projects/#creating-a-new-project) for more information.

![project menu](/images/software-help/project-menu.png)

Expand Down
2 changes: 2 additions & 0 deletions docs/content/page/software-help/projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Use the [QRiS toolbar](software-help) to create a new project. You will first ne

The QRiS project tree will be displayed, and you will be able to see the new project you have created. The project tree is used to navigate between projects layers and features. You can also use the project tree to create new layers and features, and to edit project properties.

![create project](/images/software-help/create-project.png)

## Adding an Entire Project To the Map

You can add an entire project to the map by right clicking on the top level of the project tree and selecting `Add Project to Map`. This will add all layers in the project to the map. You can also add individual layers to the map by right clicking on the layer and selecting `Add Layer to Map`.
Expand Down
32 changes: 23 additions & 9 deletions docs/content/page/software-help/sampling-frames.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Sampling Frames
banner: true
description: Riverscapes polygons for calculating metrics
---

Sampling frames are polygon feature classes that divide up your riverscapes into smaller units. Typically these individual polygons span valley wall to valley wall and longitudinally represent coherent geomorphic units, or uniform sections of river.
Expand All @@ -9,22 +10,35 @@ Sampling frames are used to define the spatial extent of your [analysis](/softwa

Sampling frames are stored within QRiS as a polygon feature class. One string attribute column can be specified as the column to be used for labels when the sampling frame is added to the map. This is useful for displaying the name of each polygon on the map. These labels can be brief names or text representations of the polygon ID etc.

![sampling frame overview](/images/software-help/sampling-frame-overview.png)

## Add an Existing Sampling Frame

You can import an existing polygon feature class and use it as a sampling frame. To do this, right click on the **AOIs** menu within the QRiS [project](/software-help/project) and select the **Add Existing Sampling** option. Browse to the location of the polygon feature class and click **Open**. Provide a name and optional description. You can also define key/value pairs of metadata that help describe the origin of the data. Click **OK** to import and create a copy of the feature class will be added to your project.
You can import an existing polygon feature class and use it as a sampling frame. To do this, right click on the **Sampling Frames** folder within the QRiS [project](/software-help/project) and select the **Add Existing Sampling Frame** menu option. Browse to the location of the polygon feature class and click **Open**. Provide a name and optional description. You can also define key/value pairs of metadata that help describe the origin of the data. Click **OK** to import and create a copy of the feature class will be added to your project.

## Create a New Sampling Frame

You can create a new sampling frame by drawing a polygon on the map. To do this, right click on the **Sampling Frames** folder within the QRiS [project](/software-help/project) and select the **Create New Sampling** menu option. Provide a name and optional description and then click **OK**. Add the Sampling Frame to the map by clicking the **Add to Map** button. You can now use the standard QGIS editing tools to digitize the sampling frame on the map. Remember to stop editing and save your changes before the sampling frame is available for use when importing other data.

![create sampling frame](/images/software-help/create-sampling-frame.png)

## Sampling Frame Polygon Considerations

## Create a New AOI
Because sampling frames are used to define the spatial extent of your [analysis](/software-help/analyses), and to define the spatial units for which you will calculate [metrics](/software-help/metrics), it is important to consider the following when creating your sampling frame:

You can create a new AOI by drawing a polygon on the map. To do this, click the **Create New AOI** button on the **Areas of Interest** folder within your QRiS [project](/software-help/project). Provide a name and optional description and then click **OK**. Add the AOI to the map by clicking the **Add to Map** button. You can now use the standard QGIS editing tools to digitize the AOI on the map. Remember to stop editing and save your changes before the AOI is available for use when importing other data.
- Polygons should span valley wall to valley wall.
- Polygons should be mutually exclusive (i.e. no overlap).
- Polygons should, in most cases, be single part features.
- Separate polygons should be used to represent different geomorphic units, uniform sections of river or planning areas.

## Add an AOI to the Map
## Add an Sampling Frame to the Map

You can add an AOI to the map by right clicking on any individual AOI in the QRiS project tree and selecting **Add to Map**. This will add the AOI to the map as a new layer.
You can add a sampling frame to the map by right clicking on any individual sampling frame in the QRiS project tree and selecting **Add to Map**. This will add the sampling frame to the map as a new layer.

## Edit an AOI
## Edit an Existing Sampling Frame

You can edit an AOI by right clicking on any individual AOI in the QRiS project tree and selecting **Edit**. This will open the AOI in QGIS and allow you to edit the AOI name and description. You can also add the AOI to the map and use the standard QGIS editing tools to edit the AOI polygon. Remember to stop editing and save your changes before the AOI is available for use when importing other data. Layers that have already been imported using the AOI will not be updated when you edit the AOI. You will need to re-import the layers to see the changes.
You can edit a sampling frame by right clicking on any individual sampling frame in the QRiS project tree and selecting **Edit**. This will open the sampling frame in QGIS and allow you to edit the name and description. You can also add the it to the map and use the standard QGIS editing tools to edit the polygons. Remember to stop editing and save your changes before the sampling frame is available for use when importing other data. Layers that have already been imported using the sampling frame will not be updated when you edit the sampling frame. You will need to re-import the layers to see the changes.

## Delete an AOI
## Delete a Sampling Frame

You can delete an AOI by right clicking on any individual AOI in the QRiS project tree and selecting **Delete**. This will remove the AOI from the QRiS project. It will not change any other data layers that used the AOI to clip the data.
You can delete a sampling frame by right clicking on it in the QRiS project tree and selecting **Delete**. This will remove the sampling frame from the QRiS project. You will not be able to delete a sampling frame if it is being used by any [analyses](/software-help/analyses). You will need to delete any analyses that use the sampling frame before you can delete it.
11 changes: 9 additions & 2 deletions docs/content/page/software-help/surfaces.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
---
title: Surfaces
banner: true
description: Contextual Raster Surfaces
---

Surfaces within QRiS refer to contextual information that is tied to a specific point in time. They are typically rasters such as satellite imagery or drone imagery, but can also be scanned topo maps, or even a simple image of a hand-drawn map. Surfaces are used to provide context to the data collected in the field, and can be used to create maps and other visualizations.

Each QRiS project has its own surface library. You can have as manay surfaces as you like, and you can upload new surfaces at any time. Each surface can be used as context for one or more [Data Capture Events](/software-help/data-capture-events).

## Import a Surface
## Import Existing Surface

To import a surface right click on the Surfaces folder in the Project Explorer and select **Import Existing Surface**. You will be prompted to select a file to upload. QRiS supports any [raster format compatible with QGiS](https://docs.qgis.org/2.18/en/docs/user_manual/working_with_vector/supported_data.html). Click OK and then provide a name and optional description for the surface.

Note that the underlying raster dataset is copied to the current QRiS project. This means that if you delete the original raster file from your computer, the surface will still be available in QRiS. However, if you move the raster file within the QRiS project, QRiS will not be able to find it and the surface will be broken.

![import existing surface](/images/software-help/create-surface.png)

- **Name** - provide a unique name for the surface. This name will be used to identify the surface in the Project Explorer and in the Data Capture Event form.
- **Source Path** - this ready only and refers to raster file that was selected.
- **Raster Type** - pick the most relevant category that best represents what type of surface you are trying to represent. This is not used by QRiS other than to select the most appropriate symbology when the raster is added to the map.
Expand Down Expand Up @@ -41,6 +44,8 @@ The raster slider tool is used to isolate regions of a raster and use them to cr

Use the **Surface Value** control or slider to pick the value at which you want to threshold the raster. You can toggle between isolating raster values that are greater than or less than the threshold value using the **Surface Value** control. You can also use the **Increment** control to adjust the amount that the surface value changes when you click the up or down arrows, or use the slider.

![raster slider](/images/software-help/raster-slider.png)

Once you have selected the threshold value, click the **Export Polygon** button to save the outline of the thresholded raster area as a new scratch polygon. Specify the properties of the scratch vector as follows:

- **Name** - provide a unique name for the scratch polygon. This name will be used to identify the polygon in the Project Explorer and in the Data Capture Event form.
Expand All @@ -50,4 +55,6 @@ Once you have selected the threshold value, click the **Export Polygon** button
- **Smoothing Offset** - this is the offset that will be used to smooth the polygon. The default value is 0.0, which means that the polygon will not be smoothed. If you want to smooth the polygon, you can specify a value here. The value is in map units, so if your map is in meters, a value of 10 will smooth the polygon by 10 meters.
- **Minimum Polygon Area** - this is the minimum area of a polygon that will be retained. This is useful if the raster slider has identified lots of small regions in the raster that possess meet the threshold.
- **Description** - provide an optional description for the scratch polygon. This description will be displayed in the Project Explorer and in the Data Capture Event form.
- **Add to Map** - if you select this option, QRiS will add the scratch vector to the map as a raster layer. This is useful if you want to check that the polygon layer has been generated correctly.
- **Add to Map** - if you select this option, QRiS will add the scratch vector to the map as a raster layer. This is useful if you want to check that the polygon layer has been generated correctly.

![raster slider export](/images/software-help/raster-slider-export.png)
4 changes: 4 additions & 0 deletions docs/gatsby-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ module.exports = {
title: 'Surfaces',
url: '/software-help/surfaces',
},
{
title: 'Sampling Frames',
url: '/software-help/sampling-frames',
},
{
title: 'Zonal Statistics',
url: '/software-help/zonal-statistics',
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/images/software-help/create-aoi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4d87dc0

Please sign in to comment.