From c904c6a4fe503cbb2d1622aadc814597eb808844 Mon Sep 17 00:00:00 2001
From: kck540 <kyle.klenk@usask.ca>
Date: Fri, 29 Apr 2022 12:15:47 -0400
Subject: [PATCH] added to documentation
---
docs/SUMMA-Actors_documentation.md | 6 ++++++
docs/{README.rst => contact.md} | 0
mkdocs.yml | 14 ++++++++++++++
utils/netcdf/StatisticsScripts/resourageUsage.py | 1 +
4 files changed, 21 insertions(+)
create mode 100644 docs/SUMMA-Actors_documentation.md
rename docs/{README.rst => contact.md} (100%)
create mode 100644 mkdocs.yml
diff --git a/docs/SUMMA-Actors_documentation.md b/docs/SUMMA-Actors_documentation.md
new file mode 100644
index 0000000..a62bb59
--- /dev/null
+++ b/docs/SUMMA-Actors_documentation.md
@@ -0,0 +1,6 @@
+# SUMMA-Actors Documentation Guide
+
+SUMMA-Actors is a beta software that currently does not have the full capabilities of the original version of SUMMA. The most notable
+feature not currently implemented is the simulation of lateral flows. SUMMA-Actors can solve for HRUs that do not have any dependencies on other HRUs. Although we are working to implement the full functionality of SUMMA into SUMMA-Actors.
+
+The documentation is organized as follows. We provide information for installing SUMMA-Actors on your system as well as some information for how to install SUMMA-Actors on Clusters such as the ones provided by Compute Canada.
\ No newline at end of file
diff --git a/docs/README.rst b/docs/contact.md
similarity index 100%
rename from docs/README.rst
rename to docs/contact.md
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..d910e09
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,14 @@
+site_name: SUMMA-Actors
+site_description: Structure for Unifying Multiple Modeling Alternatives - With Actors
+site_author: Numerical Simulations Laboratory - University of Saskatchewan
+repo_url: https://github.com/KyleKlenk/Summa-Actors
+site_url: https://summa-actors.readthedocs.io
+docs_dir: docs
+theme: readthedocs
+nav:
+- Home:
+ - SUMMA-Actors Overview: 'index.md'
+ - SUMMA-Actors Documentation: 'SUMMA-Actors_documentation.md'
+- Contact:
+ - Contact Information: "contact.md"
+
diff --git a/utils/netcdf/StatisticsScripts/resourageUsage.py b/utils/netcdf/StatisticsScripts/resourageUsage.py
index ff27a7b..9becc6d 100644
--- a/utils/netcdf/StatisticsScripts/resourageUsage.py
+++ b/utils/netcdf/StatisticsScripts/resourageUsage.py
@@ -13,6 +13,7 @@ def seffCommand(jobId, numJobs):
startHRU = 1
numHRU = 1000
for i in range(0, int(numJobs)):
+ print("Job", i)
rowData = []
rowData = [numHRU * i + 1, numHRU]
cmdString = "seff {}_{}".format(jobId, i)
--
GitLab