Skip to content

Commit 8062756

Browse files
LorinKellyMWhitehead
authored andcommitted
more updates and screenshots
1 parent 5538718 commit 8062756

11 files changed

Lines changed: 34 additions & 24 deletions

docs/docs/Deploy/install-qgis.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ sidebar_position: 2
66
sidebar_label: QGIS Install
77
---
88

9+
This page describes how to get the Riverscapes Viewer plugin for QGIS. Once you have it istalled, visit the [Software Help page](../help-qgis) for instructions on usage.
10+
911
## Plugin Installation
1012

1113
To install the Riverscapes Viewer for [QGIS](https://qgis.org/) 3.16 or later:
@@ -48,4 +50,6 @@ If you do not have [QGIS](https://qgis.org/) already, or even if you have never
4850

4951
See the [release notes](https://github.com/Riverscapes/QRAVEPlugin/releases) provided in the code repository.
5052

51-
Note: the Riverscapes Viewer for QGIS was previously known as the QRAVE plugin.
53+
:::note
54+
The **Riverscapes Viewer for QGIS** was previously known as the **QRAVE** plugin.
55+
:::

docs/docs/software-help/help-qgis/help-qgis.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If you have not already installed the Riverscapes Viewer plugin, you can do so b
1414

1515
The Viewer plugin provides a toolbar, a project explorer panel, and a metadata panel. The toolbar contains a menu with buttons for loading projects and supporting resources, along with a small handfull of related tools. The project explorer panel contains a tree view of the project layers, and provides the main way to add layers to the map.
1616

17-
![Riverscapes Viewer](/images/qviewer/viewer-overview.png)
17+
![Riverscapes Viewer](/images/qviewer/qviewer_overview_rcat_v1.1.1.windows-1280.min.png)
1818

1919
After you have installed the plugin, locate the toolbar in QGIS. If the toolbar is not visible, use the QGIS `View → Toolbars` menu and check the box next to _Riverscapes Viewer_ to make it visible.
2020

@@ -58,14 +58,14 @@ Every element within the panel tree has useful options presented in a context me
5858
Right click on the project name for the following options as shown:
5959
![Riverscapes Viewer project menu](/images/qviewer/qviewer_panel_right-click-menu_v1.1.1.windows.min.png)
6060

61-
- **Collapse All Child Nodes/Expand All Child Nodes**:
62-
- **Zoom Map to Project**: Zooms the QGIS map view to the extent of the Project as defined by the bounding box in the `project.rs.xml`.
61+
- **Collapse All Child Nodes/Expand All Child Nodes**: Collapse or expands the nodes of the project tree/
62+
- **Zoom Map to Project**: Zooms the QGIS map view to the extent of the Project as defined by the bounding box in the `project.rs.xml` (for local projects) or the project_bounds.geojson (for remote projects).
6363
- **Upload Project to Data Exchange**: Upload the project to the [Riverscapes Data Exchange](https://data.riverscapes.net). See the [Uploading Projects](/software-help/help-qgis-uploader) page for more information.
64-
- **Download or Update Project**:
64+
- **Download or Update Project**: Download the project or selected files from the project on the data exchange to a local folder. See the [Downloading Projects](qgis-downloader) page for more information.
6565
- **Browse Project Folder**: Open the folder on your computer where the project files are stored.
6666
- **View Project Metadata**: View information about the project in the metadata panel. See the [Metadata Panel](#metadata-panel) section for more information.
6767
- **View Project in Data Exchange**: Open your web browser to the Riverscapes Data Exchange page for this project (if it has been uploaded).
68-
- **Add All Layers to Map**: Add all layers in the project to the map.
68+
- **Add All Layers to Map**: Add all layers in the project to the QGIS map.
6969
- **Refresh Project Hierarchy**: Reload the project file and update the project explorer panel.
7070
- **Close Project**: Close the project and remove it from the project explorer panel.
7171

docs/docs/software-help/help-qgis/qgis-remote-projects.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ sidebar_position: 4
66
sidebar_label: Remote Projects
77
---
88

9-
The ability to browse and interact with projects in the Data Exchange without downloading any local files... watch Joe's video describing why this feature was planned for so long
10-
- don't need to download gigabytes of files when you want to look at a small area
11-
- etc.
9+
Sometimes you want to browse and interact with projects in the Data Exchange in QGIS, but without downloading those projects as local files. The **Remote Projects** feature (new in version 1.1) makes it possible to connect to a project on the Data Exchange and view any of its layers (raster and vector) using tile services that will stream only the information needed to display what you've selected in the visible area of your map window. This can be useful when you are interested in a small portion of a very large project. Once you have loaded a remote project, if you do need to do further analysis and want the local files, the viewer context menu makes it easy to [**download**](qgis-downloader) the project either in its entirety, or selectively choosing specific layers.
1210

1311
## Requirements
1412

@@ -21,9 +19,9 @@ You will need:
2119

2220
### Find and identify the Data Exchange project you want view
2321

24-
The first step in viewing a remote project in QGIS to Get the project ID. Unless it was sent to you, the easiest way to do that is to browse the Riverscapes Data Exchange at [data.riverscapes.net](https://data.riverscapes.net) and use the powerful search features. Once you find the project, you can get the Project ID in many ways:
22+
The first step in viewing a remote project in QGIS to get the project's ID, a 36-character unique identifier for every project assigned by the Data Exchange when a project is uploaded. Unless it was sent to you, the easiest way to do that is to browse the Riverscapes Data Exchange at [data.riverscapes.net](https://data.riverscapes.net) and use the powerful search features. Once you find the project, you can get the Project ID in many ways:
2523

26-
* on a project page, you can copy the URL
24+
* on a project page, you can copy the URL. This contains the project ID and the remote projects dialog will parse it from the page URL.
2725
* on a project page, there is a widget in top right corner to copy the project to clipboard, shown below. Choose `Copy project ID`.
2826
* on a project page, in the overview tab, the PROJECT ID is displayed, and there is a copy to clipboard button next to it
2927
* in project 'cards' shown in search results, the kebob menu has a Copy Project ID to clipboard option
@@ -36,7 +34,8 @@ If you have the project downloaded and loaded into the riverscapes viewer, you c
3634

3735
* From the Riverscapes Viewer toolbar button, choose Open Remote Project as shown.
3836
![menu](/images/qviewer/qviewer_menu_remote_project_highlighted_v1.1.1_windows.min.png)
39-
* Paste the Project id in the dialog.
37+
* Paste the Project id in the dialog
38+
![open remote project dialog](/images/qviewer/qviewer_remote_open_dialog_v1.1.1.windows.min.png)
4039
* A browser window will open to authenticate your account (only once per QGIS session).
4140
* The project will appear in the Riverscapes Viewer Pane, and the default view will open in the map.
4241

docs/docs/software-help/help-qgis/qgis-uploader.mdx

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: qgis-uploader
55
sidebar_position: 3
66
---
77

8-
With the Riverscapes Viewer for QGIS you can upload riverscapes projects into the [Riverscapes Data Exchange](https://data.riverscapes.net). This feature is intended for uploading a single riverscapes project at a time. You should use the [Riverscapes Command Line Interface](https://docs.riverscapes.net/products/rscli) (rscli) if your goal is to upload more than a handful of projects. The uploader can be used both to upload a new project, or to make changes to an existing project.
8+
With the Riverscapes Viewer for QGIS you can upload riverscapes projects into the [Riverscapes Data Exchange](https://data.riverscapes.net). This feature is intended for uploading a single riverscapes project at a time. You should use the [Riverscapes Command Line Interface](https://docs.riverscapes.net/products/rscli) (rscli) if your goal is to upload more than a handful of projects. The uploader can be used both to upload a new project, or to make changes to an existing project. It allows selective uploading of specific files.
99

1010
:::info
1111
This feature is only available in Riverscapes Viewer for QGIS. It is not available in the ArcGIS or ArcGIS Pro versions of the Viewer.
@@ -21,7 +21,7 @@ This feature requires that you have the following:
2121
## Getting Started
2222

2323
1. Open the project you want to upload with the Riverscapes Viewer.
24-
1. Right click on the project node in the Riverscapes Viewer pane and choose `Upload Project to Data Exchange`.
24+
2. Right click on the project node in the Riverscapes Viewer pane and choose `Upload Project to Data Exchange`.
2525

2626
![upload menu](/images/qviewer/qviewer_panel_right-click-menu_uploadcircled_v1.1.1.windows.min.png)
2727

@@ -53,25 +53,31 @@ Click `Next` to proceed to file selection.
5353

5454
## Step 2: File Selection
5555

56-
In the second step, you will see a list of all files in your project and their status relative to the Data Exchange. (New, Update, or Delete).
56+
In the second step, you will see a list of all files in your project, their size, and their status relative to the Data Exchange. For each file you can choose what happens with it, depending on its Status:
5757

58-
- **New** Files that don't exist on the Data Exchange yet.
59-
- **No change** Files that already exist on the Data Exchange.
60-
- **Update** Files that have changed locally and need to be re-uploaded.
61-
- **Delete** Files that exist on the Data Exchange but not locally. These will be removed from the data exchange only if the option "Delete remote files that are not present locally" is selected.
58+
- **New** Files that don't exist on the Data Exchange yet. These will be uploaded if the checkbox is selected.
59+
- **No change** Files that already exist on the Data Exchange. These will be left on the server if the checkbox is selected, but will be **deleted** if the checkbox is deselected.
60+
- **Update** Files that have changed locally and need to be re-uploaded. They will be uploaded if the checkbox is selected.
61+
- **Delete** Files that exist on the Data Exchange but not locally. These will be removed from the data exchange only if the checkbox is selected **and** the option "Delete remote files that are not present locally" is also selected.
6262

63-
For each file you can choose whether to upload it. For a file that exists, unchecking this box will delete the remote file.
63+
![uploader file selection](/images/qviewer/uploader_step2_fileselection_v1.1.1.windows.min.png)
6464

65-
Review the list carefully and the summary of what will be changed at the bottom to ensure it matches your expectations. Click `Start Upload` to begin the process.
65+
Review the list carefully and check the summary of what will be changed at the bottom to ensure it matches your expectations. In the screenshot above:
66+
67+
* the 2 files that will be uploaded are `initial_point.geojson` (status *New*) & `project.rs.xml` (status *Update*)
68+
* the 1 file that will be deleted is `original_project.rs.xml` (status *No change*)!
69+
* `rcat.log` (status *Delete*) will not be removed from the server because "Delete remote files that are not present locally" is unchecked.
70+
71+
Click `Start Upload` to begin the process.
6672

6773
### Notes
6874

6975
:::caution
7076
Modifying an existing project in the Data Exchange is permanent and cannot be undone.
7177
:::
7278

73-
- For projects that originated from the Data Exchange, a comprehensive file hash check is used to determine which files have changed relative to those that already exist online. Only files that have changed are uploaded.
74-
- Note that the simple act of adding a GeoPackage layer to the map in QGIS will ever so slightly change the underlying GeoPackage file on disk. This means that downloading, viewing and then re-uploading a Riverscapes project will likely detect changes in GeoPackages that have been used, even if you haven't explicitly made any changes to the data. This is a limitation of the GeoPackage format and not a bug in the uploader. Given that most Riverscapes project types have a [default project view](https://viewer.riverscapes.net/technical-reference/business-logic/#project-views) that loads one or more GeoPackage layers into the map, this is a common scenario. The uploader will detect these changes. You can choose whether or not to upload the modified GeoPackages. Either way this is not a problem, but it is something to be aware of.
79+
- For projects that originated from the Data Exchange, a comprehensive *file hash check*, essentially a digital fingerprint, to determine which files have changed relative to those that already exist online. To save time and bandwidth, only files that have changed and are selected are uploaded.
80+
- Simply opening a GeoPackage layer in QGIS can sometimes alter the file's digital fingerprint on your disk. This happens because QGIS and its underlying database enginge (SQLite) perform minor 'housekeeping" tasks, such as updating timestamps, the moment a file is accessed. With any change, no matter how small, the uploader will flag these GeoPackages as changed (Status: *Update*), even if you didn't edit any data. You can choose whether or not to upload these modified files.
7581

7682
## Step 3: Upload Status
7783

@@ -83,7 +89,8 @@ The final step shows the progress of your upload.
8389

8490
Click `View in Data Exchange` to see your project online.
8591

86-
8792
## Video Demonstration
8893

94+
This video demonstrates uploading in an older version of the Viewer. A new video is coming soon.
95+
8996
<YouTubeEmbed videoId="Rs6RnAHAsNY?si=pj7B50YYxs7swcZC"/>
820 KB
Loading
145 KB
Loading
511 KB
Loading
9.33 KB
Loading
22.8 KB
Loading
21.8 KB
Loading

0 commit comments

Comments
 (0)