updated Readme file

sandialabs · Aug 28, 2023 · ad45187 · ad45187
1 parent e40ea01
commit ad45187
Show file tree

Hide file tree

Showing 15 changed files with 8 additions and 633 deletions.
diff --git a/README.md b/README.md
@@ -60,13 +60,18 @@ Below is a brief description of the repository contents.
   - [.pre-commit-config.yaml](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/.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](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/create_zip.sh): Shell script to create a zipped code archive locally, which can be imported to the QGIS plugin installer.
   - [seat-qgis-plugin/code](https://github.com/IntegralEnvision/seat-qgis-plugin/tree/main/code): Plugin code.
-    - [stressor_receptor_calc.py](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/stressor_receptor_calc.py): Main plugin script doing the heavy lifting.
+    - [stressor_receptor_calc.py](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/stressor_receptor_calc.py): Main plugin script for input and display.
     - [stressor_receptor_calc_dialog.py](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/stressor_receptor_calc_dialog.py): Initializes the plugin GUI.
     - [stressor_receptor_calc_dialog_base.ui](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/stressor_receptor_calc_dialog_base.ui): Interface configuration (generated with Qt Designer).
-    - [resources.qrc](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/resources.qrc): Application resources such as icons and trnalsation files.
+    - [resources.qrc](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/resources.qrc): Application resources such as icons and translation files.
     - [resources.py](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/resources.py): Resource file generated from compiling resources.qrc.
     - [plugin_upload.py](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/plugin_upload.py): Utility - upload a plugin package to the [QGIS plugin repository](https://plugins.qgis.org/plugins/).
     - [pb_tool.cfg](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/pb_tool.cfg): Configuration file for the plugin builder tool.
     - [metadata.txt](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/metadata.txt): Plugin metadata.
     - [icon.png](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/icon.png): Plugin icon.
-    - [compile.bat](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/compile.bat): Compile plugin resources (Windows).
+    - [compile.bat](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/compile.bat): Compile plugin resources (Windows).
+    - [shear_stress_module.py](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/shear_stress_module.py): Calculates and generates the shear stress stressor maps and statistics files.
+    - [velocity_module.py](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/velocity_module.py): Calculates and generates the velocity stressor maps and statistics files.
+    - [acoustics_module.py](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/acoustics_module.py): Calculates and generates the paracousti stressor maps and statistics files.
+    - [power_module.py](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/power_module.py): Calculates and generates the wec/cec power generated plots and statistics files.
+    - [stressor_utils.py](https://github.com/IntegralEnvision/seat-qgis-plugin/blob/main/code/stressor_utils.py): General processing scripts.
diff --git a/code/test/__init__.py b/code/test/__init__.py
diff --git a/code/test/qgis_interface.py b/code/test/qgis_interface.py
diff --git a/code/test/tenbytenraster.asc b/code/test/tenbytenraster.asc
diff --git a/code/test/tenbytenraster.asc.aux.xml b/code/test/tenbytenraster.asc.aux.xml
diff --git a/code/test/tenbytenraster.keywords b/code/test/tenbytenraster.keywords
diff --git a/code/test/tenbytenraster.lic b/code/test/tenbytenraster.lic
diff --git a/code/test/tenbytenraster.prj b/code/test/tenbytenraster.prj
diff --git a/code/test/tenbytenraster.qml b/code/test/tenbytenraster.qml
diff --git a/code/test/test_init.py b/code/test/test_init.py