Sandia Spatial Environmental Assessment Toolkit QGIS Plugin

This repository contains code for the Spatial Environmental Assessment Toolkit (SEAT) QGIS Plugin. This is a collaboration between Integral Consulting and Sandia National Laboratories.

Installation

Requirements

• QGIS >= 3.16

• Python for QGIS >= 3.16

• netCDF >= 3.5.4 - Python install location varies depending on your OS.

  • Windows - run C:\Program Files\QGIS 3.16\OSGeo4W.bat as administrator.

  • Linux & MacOS - Open the Python console in QGIS and enter the commands below to determine where your Python install is:

    import sys
    print(sys.exec_prefix)

Plugin Install

Download the latest release zip file. You can then use the Install from zip option under the Install Plugins dialog in QGIS.

The installed plugin is located here:

• Windows: AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins
• Linux: .local/share/QGIS/QGIS3/profiles/default/python/plugins
• Mac Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins

Development

The codebase was initially generated using the Qgis-Plugin-Builder. Follow the PyQGIS Developer Cookbook for documentation on developing plugins for QGIS with Python.

There are two QGIS plugins that are helpful during the development process:

• Plugin Reloader
• FirstAid

Releases

To trigger a release buid on GitHub use the following commands:

git tag -a <version> -m "<release notes>"
git push --tag

Contents

Below is a brief description of the repository contents.

• seat-qgis-plugin: Repository root.

  • .github/workflows/release.yaml: Automated GitHub routine that is triggered upon committing a new tag.
  • .pre-commit-config.yaml: Collection of hooks to run prior to committing the code state to Git. Hooks include linters and code formatters.
  • create_zip.sh: Shell script to create a zipped code archive locally, which can be imported to the QGIS plugin installer.
  • seat-qgis-plugin/seat: Plugin code.
    • stressor_receptor_calc.py: Main plugin script for input and display.
    • stressor_receptor_calc_dialog.py: Initializes the plugin GUI.
    • stressor_receptor_calc_dialog_base.ui: Interface configuration (generated with Qt Designer).
    • resources.qrc: Application resources such as icons and translation files.
    • resources.py: Resource file generated from compiling resources.qrc.
    • plugin_upload.py: Utility - upload a plugin package to the QGIS plugin repository.
    • pb_tool.cfg: Configuration file for the plugin builder tool.
    • metadata.txt: Plugin metadata.
    • icon.png: Plugin icon.
    • compile.bat: Compile plugin resources (Windows).
    • shear_stress_module.py: Calculates and generates the shear stress stressor maps and statistics files.
    • velocity_module.py: Calculates and generates the velocity stressor maps and statistics files.
    • acoustics_module.py: Calculates and generates the paracousti stressor maps and statistics files.
    • power_module.py: Calculates and generates the wec/cec power generated plots and statistics files.
    • stressor_utils.py: General processing scripts.