# Riverscapes Viewer

The Riverscapes Viewer (formerly QRAVE) is a [QGIS](http://www.qgis.org/en/site/) plugin you can use to interact with riverscapes data. See the online documentation for more information:

[viewer.riverscapes.net](https://viewer.riverscapes.net/software-help/help-qgis/)

## Acknowledgements

The Riverscapes Viewer Plugin software was developed by North Arrow Research Ltd., with funding from the [Bonneville Power Administration](https://www.bpa.gov/) (BPA) BPA Fish and Wildlife Program Project [#2011-006](http://www.cbfish.org/Project.mvc/Display/2011-006-00). Contributions were also made by [South Fork Research](http://www.southforkresearch.org/) and members of the [Fluvial Habitats Center](http://etal.joewheaton.org/a/joewheaton.org/et-al/) at Utah State University.

## For Developers

Full developer documentation — including platform setup (macOS, Windows, Ubuntu),
VS Code workspace files, linting, building, and deployment — is in:

**[DEVELOPER.md](DEVELOPER.md)**

Quick links:
- [macOS QGIS 3 setup](DEVELOPER.md#31-macos--qgis-3)
- [macOS QGIS 4 setup](DEVELOPER.md#32-macos--qgis-4)
- [Windows setup](DEVELOPER.md#33-windows--qgis-3)
- [Ubuntu / Linux setup](DEVELOPER.md#34-ubuntu--linux--qgis-3)
- [Linting and formatting (Ruff)](DEVELOPER.md#9-linting-and-formatting)
- [Compiling resources](DEVELOPER.md#7-compiling-resources-and-ui-files)
- [Deploying locally](DEVELOPER.md#8-deploying-to-your-local-qgis-profile)
- [QGIS 3 → QGIS 4 migration notes](UPGRADE.md)

## License

Licensed under the [GNU General Public License Version 3](https://github.com/Riverscapes/RiverscapesToolbar/blob/master/LICENSE).
