Skip to content

Commit

Permalink
docs and upgraded theme
Browse files Browse the repository at this point in the history
  • Loading branch information
philipbaileynar committed May 26, 2024
1 parent 278e810 commit 750373a
Show file tree
Hide file tree
Showing 16 changed files with 39 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To install Riverscapes Viewer for first time to ArcGIS:

## Updates

To update the addin, first remove any existing installations. Within ArcMap go to `Customize → AddIn Manager` on the main menu, select ArcRAVE and click "Delete AddIn". Close ArcMap and install as per the following video.
To update the addin, first remove any existing installations. Within ArcMap go to `Customize → AddIn Manager` on the main menu, select ArcViewer and click "Delete AddIn". Close ArcMap and install as per the following video.

<div class="responsive-embed">
<iframe width="560" height="315" src="https://www.youtube.com/embed/is_9c7eYGl0" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ banner: true
description: Riverscapes Viewer for the Web
---

As the name suggests, webRAVE works in any modern web browser and doesn't need to be installed. You get to webRAVE by click on the globe icon nest to projects in the [Riverscapes Data Warehouse](https://data.riverscapes.net).
As the name suggests, webViewer works in any modern web browser and doesn't need to be installed. You get to webViewer by click on the globe icon nest to projects in the [Riverscapes Data Warehouse](https://data.riverscapes.net).

Most modern web browsers should work. Chromium based browsers such as Chrome, Brave and Edge are recommended. Internet Explorer is not supported.
File renamed without changes.
8 changes: 3 additions & 5 deletions docs/content/page/about/acknowledgements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@ banner: true
description: Riverscapes Viewer Contributors
---

The Riverscapes Viewer is brought to you for free by the [Riverscapes Consortium](http://riverscapes.net). It is how you visualize and explore _any_ [Riverscapes Project](https://riverscapes.net/Tools/Technical_Reference/Documentation_Standards/Riverscapes_Projects/) found in the [Riverscapes Warehouse](https://riverscapes.net/Data_Warehouses/).
The Riverscapes Viewer is brought to you for free by the [Riverscapes Consortium](http://riverscapes.net). It is how you visualize and explore _any_ [Riverscapes Project](https://riverscapes.net/Tools/Technical_Reference/Documentation_Standards/Riverscapes_Projects/) found in the [Riverscapes Data Exchange](https://data.riverscapes.net).

## Developers

[North Arrow Research](https://northarrowresearch.com) developed the Riverscapes Viewere suite of tools.

For a complete list of developers and their contributions, see Github [ArcViewer](https://github.com/Riverscapes/RaveAddIn/graphs/contributors) and [QViewer](https://github.com/Riverscapes/QRAVEPlugin/graphs/contributors) repositories.
[North Arrow Research](https://northarrowresearch.com) developed the Riverscapes Viewere suite of tools. For a complete list of developers and their contributions, see Github [ArcViewer](https://github.com/Riverscapes/RaveAddIn/graphs/contributors) and [QViewer](https://github.com/Riverscapes/QRAVEPlugin/graphs/contributors) repositories.

## Project Curators

Expand All @@ -22,4 +20,4 @@ For a complete list of curators and developers and their contributions, see Gith

Riverscapes Viewer development has been funded primarily by the [Bureau of Land Management](https://www.blm.gov/montana-dakotas) and [Anabranch Solutions](http://anabranchsolutions.com). BLM has supproted the development of ArcViewer & WebViewer. This support has been through co-operative agreements between BLM and Utah State University, with subawards to North Arrow Research.

[Anabranch Solutions](http://anabranchsolutions.com) funded the development of QViewer, so that a completely free, open-source GIS alternative to access the Viewer from within [QGIS](https://qgis.org/en/site/) was accessible to those without access to ESRI's ArcGIS.
[Anabranch Solutions](http://anabranchsolutions.com) funded the development of QViewer so that a completely free, open-source GIS alternative to access the Viewer from within [QGIS](https://qgis.org/en/site/) was accessible to those without access to ESRI's ArcGIS.
2 changes: 1 addition & 1 deletion docs/content/page/about/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ banner: true
description: Background information about the Riverscapes Viewers
---

The Riverscapes Viewer is one of several [applicaitons](https://riverscapes.github.io/riverscapes-website/our-work/apps/) the [Riverscapes Consortium's](http://riverscapes.net) has developed for unlocking riverscapes data. The Viewer itself does not do any analysis, but allows exploring of any [Riverscapes project](https://riverscapes.github.io/riverscapes-website/Technical_Reference/Documentation_Standards/Riverscapes_Projects/). It is both i) a geospatial data explorer in which you can navigate the "project tree" of GIS data within a project, and add layers to map symbolized appropriately; as well as a ii) data exporer.
The Riverscapes Viewer is one of several [applications](https://www.riverscapes.net/page/apps) the [Riverscapes Consortium's](http://riverscapes.net) has developed for unlocking riverscapes data. The Viewer itself does not do any analysis, but allows exploring of any (Riverscapes project](https://riverscapes.github.io/riverscapes-website/Technical_Reference/Documentation_Standards/Riverscapes_Projects/), including those downloaded from the [Riverscapes Date Exchange](https://data.riverscapes.net). It is both i) a geospatial data explorer in which you can navigate the "project tree" of GIS data within a project, and add layers to map symbolized appropriately; as well as a ii) data exporer.

The following video provides a brief overview.

Expand Down
6 changes: 5 additions & 1 deletion docs/content/page/about/license.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The Riverscapes Viewer is made available under the [GNU Public License Version 3

## Web Viewer

WebRAVE is written using a collection of web technologies, most notably React and node.js.
The Web Viewer is written using a collection of web technologies, most notably React and node.js.

## QViewer for QGIS

Expand All @@ -16,3 +16,7 @@ The [QViewer code](https://github.com/Riverscapes/QRAVEPlugin) is written in Pyt
## ArcViewer for ArcGIS 10.x

The [ArcViewer code](https://qgis.org) is written in C# using Visual Studio 2015 and requires [ArcGIS](https://esri.com) 10.x to be installed along with the Software Development Kit (SDK). There is currently no version for ArcPro.

## ArcViewer for ArcPro

A new version of the Viewer for ArcPro is under development and scheduled for release in 2024.
2 changes: 1 addition & 1 deletion docs/content/page/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import QCardImage from '/static/images/qviewer/RV_Q.png'

<Container maxWidth="xl">

Our **Riverscapes Viewers** make it easy to explore _riverscape projects_ as maps. Developed by the [Riverscapes Consoritum](https://riverscapes.net), these tools are available as both a [web application](software-help/help-web) and desktop GIS plugins for [QGIS](software-help/help-qgis) and Esri's [ArcGIS](software-help/help-arc). They simplify the process of adding riverscape-related data to your preferred GIS platform, ensuring meaningful layer organization and symbology. We offer three versions of the **Riverscapes Viewer** to meet your specific needs.
**Riverscapes Viewers** make it easy to explore _riverscape projects_ as maps. Developed by the [Riverscapes Consoritum](https://riverscapes.net), these tools are available as both a [web application](software-help/help-web) and desktop GIS plugins for [QGIS](software-help/help-qgis) and Esri's [ArcGIS](software-help/help-arc). They simplify the process of adding riverscape-related data to your preferred GIS platform, ensuring meaningful layer organization and symbology. We offer three versions of the **Riverscapes Viewer** to meet your specific needs.

<Container maxWidth="xl">
<Grid container spacing={4} sx={{mt: 3}} padding={0}>
Expand Down
2 changes: 1 addition & 1 deletion docs/content/page/software-help/help-arc.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Arc RiverscapesViewer Help
title: Arc Viewer Help
banner: true
description: Help with the Riverscapes Viewer for ArcGIS 10.x
---
Expand Down
2 changes: 1 addition & 1 deletion docs/content/page/software-help/help-qgis-uploader.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Uploading Projects
banner: true
description: Uploading Projects to the Riverscapes Data Exchange
description: Using QViewer to Upload Projects into the Riverscapes Data Exchange
---

# Uploading Riverscapes Projects
Expand Down
6 changes: 6 additions & 0 deletions docs/content/page/technical-reference/base-maps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ banner: true
description: How to define basemaps for desktop Viewer versions
---

<Alert severity="info">
Note that Base Maps use and refer to files on your computer located in a folder called `RAVE`. The name of this folder refers to the previous name for Riverscapes Viewer that used the acronym RAVE (Riverscapes Analyst Viewer and Explorer).
</Alert>



# Base Map Definition Files

The base maps available within the Riverscapes Viewer are listed in plain text XML files called `BaseMaps.xml`. The Viewer looks in two locations for this file in a specific order:
Expand Down
12 changes: 8 additions & 4 deletions docs/content/page/technical-reference/business-logic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ banner: true
description: How to define Riverscapes Viewer Project Trees
---

<Alert severity="info">
Note that Business Logic uses and refer to files on your computer located in a folder called `RAVE`. The name of this folder refers to the previous name for Riverscapes Viewer that used the acronym RAVE (Riverscapes Analyst Viewer and Explorer).
</Alert>

# Introduction

The purpose of the business logic is to translate riverscpaes projects and determine how they should be displayed in the Viewer project explorer. In other words, the Riverscapes project file defines **what** layers exist within a project, while the business logic file defines **how** these layers should be organized within the project explorer tree and be displayed when added to map.
Expand All @@ -19,7 +23,7 @@ When the Viewer attempts to load a Riverscapes project it looks in three locatio
1. User-loaded from **Customize Project Hierarchy** command (Priority 1)
2. In the root directory of the current project (Priority 2)
3. Local user default over-ride for that project type (Priority 3)
4. Default that ships with that version of the Viewer (Priority 4) - *Note that you should always make sure you have the [latest verson of RAVE](https://github.com/Riverscapes/RaveAddIn/releases/latest) as default symbology and business logic updates are published in new releases.*
4. Default that ships with that version of the Viewer (Priority 4) - *Note that you should always make sure you have the [latest verson of the Viewer](https://github.com/Riverscapes/RaveAddIn/releases/latest) as default symbology and business logic updates are published in new releases.*

The Viewer uses the first business logic file that it finds that contains the same project type specified at the top of the business logic file. Note that Priorities 2 & 3 represent user customization and Priority 1 is where the user can manually load business logic with the **Customize Project Hierarchy** command (see below). See the [symbology page](symbology.html#where-is-my-appdata-folder) for how to locate your APPDATA folder.

Expand All @@ -40,12 +44,12 @@ You can load a custom business logic file stored in a location on your computer

## Customizing Business Logic & Refreshing the Project Explorer

You can customize the business logic XML file while ArcMap and QGIS are in use, providing that the business logic file in question is either adjacent to the Riverscapes project file or in the APPDATA folder. **WARNING** - the business logic is written in XML and is fiddly (see these instructions). Make small changes locally incrementally (either in Priority 2 or 3 locations on disc), and frequently referesh and test within RAVE.
You can customize the business logic XML file while ArcMap and QGIS are in use, providing that the business logic file in question is either adjacent to the Riverscapes project file or in the APPDATA folder. **WARNING** - the business logic is written in XML and is fiddly (see these instructions). Make small changes locally incrementally (either in Priority 2 or 3 locations on disc), and frequently referesh and test within the Viewer.

1. Locate the business logic file you wish to use and open it in any text editor (we strongly recommend following [these instructions](https://riverscapes.net/Tools/Technical_Reference/Documentation_Standards/Riverscapes_Projects/xml_validation.html) for editing and authoring riverscapes XML in Visual Studio Code so that it validates your XML).
1. Make the desired changes to the business logic XML.
1. Save the business logic XML file (to project for Priority 2, or to `%APPDATA%\RAVE\XML\` for Priority 3).
1. Right click on the project node in the RAVE project explorer and choose "Refresh".
1. Right click on the project node in the Viewer project explorer and choose "Refresh".

![refresh](/images/refresh.png)

Expand Down Expand Up @@ -191,4 +195,4 @@ This video illustrates how this works:

## Option 3: Suggesting a New Default Business Logic for Existing or New Riverscape Project Type

If you would like the Riverscapes Consortium development team to consider your business logic updates and symbology updates for the next release of RAVE, propose a pull request to the [RaveAddIn repository](https://github.com/Riverscapes/RaveAddIn) . If you are part of the Riverscapes Consortium development team, you can do this by making a local Branch, making your commits and pushes to that branch (name it something logical like `ProposedSybmologyMyModel`) and then log a pull request and ask for a review. If you are not part of the development team, you can fork the repo, make your changes on your own repo and then submit a pull request. This request will be reviewed by the development team and they may ask for fixes after testing it. If accepted, this will be merged into the main branch and reflected in the next release.
If you would like the Riverscapes Consortium development team to consider your business logic updates and symbology updates for the next release of the Viewer, propose a pull request to the [Riverscapes XML repository](https://github.com/Riverscapes/RiverscapesXML) . If you are part of the Riverscapes Consortium development team, you can do this by making a local branch, making your commits and pushes to that branch (name it something logical like `ProposedSybmologyMyModel`) and then log a pull request and ask for a review. If you are not part of the development team, you can fork the repo, make your changes on your own repo and then submit a pull request. This request will be reviewed by the development team and they may ask for fixes after testing it. If accepted, this will be merged into the main branch and reflected in the next release.
9 changes: 5 additions & 4 deletions docs/gatsby-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,19 @@ module.exports = {
items: [
{
title: 'Install for QGIS',
url: '/download/install-qgis',
url: '/Download/install-qgis',
},
{
title: 'Install for ArcGIS',
url: '/download/install-arc',
url: '/Download/install-arc',
},
{
title: 'Using Web Viewer',
url: '/download/install-web',
url: '/Download/install-web',
},
{
title: 'Questions, Feature Requests & Bugs',
url: '/download/known-bugs',
url: '/Download/known-bugs',
}
],
},
Expand Down Expand Up @@ -125,6 +125,7 @@ module.exports = {
short_name: `RiverscapesTemplate`,
// TODO: You need to change this to your site's URL. This should match the `pathPrefix` above.
start_url: `/`,
iconUrl: `./static/viewer_favicon.png`,
},
},
},
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"license": "MIT",
"author": "Matt Reimer <matt@northarrowresearch.com>",
"dependencies": {
"@riverscapes/gatsby-theme": "^0.1.26",
"@riverscapes/gatsby-theme": "^0.1.28",
"gatsby": "^5.10.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
Expand Down
Binary file added docs/static/viewer_favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3243,9 +3243,9 @@ __metadata:
languageName: node
linkType: hard

"@riverscapes/gatsby-theme@npm:^0.1.26":
version: 0.1.26
resolution: "@riverscapes/gatsby-theme@npm:0.1.26"
"@riverscapes/gatsby-theme@npm:^0.1.28":
version: 0.1.28
resolution: "@riverscapes/gatsby-theme@npm:0.1.28"
dependencies:
"@emotion/react": "npm:^11.11.0"
"@emotion/styled": "npm:^11.11.0"
Expand Down Expand Up @@ -3273,15 +3273,15 @@ __metadata:
gatsby: ^5.13.0
react: ^18.2.0
react-dom: ^18.2.0
checksum: 10c0/ee54e10cf4512a50e34917415ef201903525a3556cbab9d21f08da418f274f2707a9cd56cce3f1613b11d2a90e13f4f354aa3c920258a2ac1f923d9476403924
checksum: 10c0/17d4f241e417cb683d75c0758f8ceae2a86850539c5ff04e96fde8093b60417d58cafb4b8478c07ecfce6b3824440734b49522c13487d9ad86a3a3479d141866
languageName: node
linkType: hard

"@riverscapes/template-clean@workspace:.":
version: 0.0.0-use.local
resolution: "@riverscapes/template-clean@workspace:."
dependencies:
"@riverscapes/gatsby-theme": "npm:^0.1.26"
"@riverscapes/gatsby-theme": "npm:^0.1.28"
gatsby: "npm:^5.10.0"
react: "npm:^18.2.0"
react-dom: "npm:^18.2.0"
Expand Down

0 comments on commit 750373a

Please sign in to comment.