Merge pull request #54 from OpenWaterAnalytics/dev-rename

michaeltryby · web-flow · commit b33371d17679 · 2020-12-04T17:03:34.000-05:00
Dev rename
diff --git a/.coveralls.yml.enc b/.coveralls.yml.enc
diff --git a/appveyor.yml b/appveyor.yml
diff --git a/swmm-toolkit/AUTHORS b/swmm-toolkit/AUTHORS
@@ -0,0 +1,5 @@
+# Authors ordered by first contribution
+
+Michael Tryby <tryby.michael@epa.gov> (public domain)
+Jennifer Wu <jennifer.wu@xyleminc.com>
+Caleb Buahin <caleb.buahin@xyleminc.com>
diff --git a/swmm-toolkit/CMakeLists.txt b/swmm-toolkit/CMakeLists.txt
@@ -4,8 +4,7 @@
 # Created:   Feb 6, 2020
 # Modified   May 7, 2020
 #
-# Author: Michael E. Tryby
-#         US EPA ORD/CESER
+#  Author:     See AUTHORS
 #
 
 
diff --git a/swmm-toolkit/LICENSE.md b/swmm-toolkit/LICENSE.md
@@ -155,5 +155,6 @@ For more information, please see
 
 # Third-Party Libraries
 
-
 ## OWA SWMM
+
+## OpenMP
diff --git a/swmm-toolkit/setup.py b/swmm-toolkit/setup.py
@@ -4,8 +4,7 @@
 # Created:    Jul 2, 2018
 # Updated:    May 7, 2020
 #
-# Author:     Michael E. Tryby
-#             US EPA - ORD/NRMRL
+#  Author:    See AUTHORS
 #
 # Suggested Usage:
 #   python setup.py build
diff --git a/swmm-toolkit/src/swmm/toolkit/CMakeLists.txt b/swmm-toolkit/src/swmm/toolkit/CMakeLists.txt
@@ -4,8 +4,7 @@
 # Created:   Feb 6, 2020
 # Updated:   May 6, 2020
 #
-# Author:    Michael E. Tryby
-#            US EPA ORD/CESER
+#  Author:   See AUTHORS
 #
 
 
diff --git a/swmm-toolkit/src/swmm/toolkit/__init__.py b/swmm-toolkit/src/swmm/toolkit/__init__.py
@@ -6,8 +6,7 @@
 #  Created:    Aug 9, 2018
 #  Updated:    May 20, 2020
 #
-#  Author:     Michael E. Tryby
-#              US EPA - ORD/NRMRL
+#  Author:     See AUTHORS
 #
 
 '''
diff --git a/swmm-toolkit/src/swmm/toolkit/output.i b/swmm-toolkit/src/swmm/toolkit/output.i
@@ -4,8 +4,7 @@
  *  Created:    November 3, 2017
  *  Updated:    February 21, 2020
  *
- *  Author:     Michael E. Tryby
- *              US EPA - ORD/NRMRL
+ *  Author:     See AUTHORS
  *
 */
 
diff --git a/swmm-toolkit/src/swmm/toolkit/output_metadata.py b/swmm-toolkit/src/swmm/toolkit/output_metadata.py
@@ -1,11 +1,10 @@
 #
 #  output_metadata.py -
 #
-#  Created: February 20, 2020
+#  Created:  February 20, 2020
 #  Updated:
 #
-#  Author:     Michael E. Tryby
-#              US EPA - ORD/CESER
+#  Author:   See AUTHORS
 #
 
 
diff --git a/swmm-toolkit/src/swmm/toolkit/output_rename.i b/swmm-toolkit/src/swmm/toolkit/output_rename.i
@@ -3,8 +3,7 @@
  *
  *  Created:    2/12/2020
  *
- *  Author:     Michael E. Tryby
- *              US EPA - ORD/CESER
+ *  Author:     See AUTHORS
  *
 */
 
diff --git a/swmm-toolkit/src/swmm/toolkit/solver.i b/swmm-toolkit/src/swmm/toolkit/solver.i
@@ -4,14 +4,8 @@
  *  Created:    7/2/2018
  *  Updated:    8/17/2020
  *
- *  Author:     Michael E. Tryby
- *              US EPA - ORD/NRMRL
- *
- *  Author:     Jennifer Wu
- *              Xylem Inc.
- *
- *  Author:     Caleb Buahin
- *              Xylem Inc.
+ *  Author:     See AUTHORS
+ * 
 */
 
 
diff --git a/swmm-toolkit/src/swmm/toolkit/solver_rename.i b/swmm-toolkit/src/swmm/toolkit/solver_rename.i
@@ -3,86 +3,95 @@
  *
  *  Created:    2/26/2020
  *  
- *  Authors:    Michael E. Tryby
- *              US EPA - ORD/CESER
- *
- *              Jennifer Wu
- *              Xylem Inc.
+ *  Author:     See AUTHORS
  *
 */
 
 
 // RENAME FUNCTIONS ACCORDING TO PEP8
-%rename(run)                                        swmm_run;
-%rename(open)                                       swmm_open;
-%rename(start)                                      swmm_start;
-%rename(step)                                       swmm_step;
-%rename(end)                                        swmm_end;
-%rename(report)                                     swmm_report;
-%rename(get_mass_bal_err)                           swmm_getMassBalErr;
-%rename(close)                                      swmm_close;
-%rename(version)                                    swmm_getVersion;
-
-%rename(version_info)                               swmm_getVersionInfo;
-%rename(system_get_routing_totals)                  swmm_getSystemRoutingTotals;
-%rename(system_get_runoff_totals)                   swmm_getSystemRunoffTotals;
-
-%rename(object_find)                                swmm_project_findObject;
-%rename(object_count)                               swmm_countObjects;
-%rename(object_get_index)                           swmm_getObjectIndex;
-%rename(object_get_id)                              swmm_getObjectId;
-
-%rename(simulation_get_unit)                        swmm_getSimulationUnit;
-%rename(simulation_get_datetime)                    swmm_getSimulationDateTime;
-%rename(simulation_set_datetime)                    swmm_setSimulationDateTime;
-%rename(simulation_get_analysis_setting)            swmm_getSimulationAnalysisSetting;
-%rename(simulation_get_parameter)                   swmm_getSimulationParam;
-%rename(simulation_get_current_datetime)            swmm_getCurrentDateTime;
-
-%rename(node_get_type)                              swmm_getNodeType;
-%rename(node_get_parameter)                         swmm_getNodeParam;
-%rename(node_set_parameter)                         swmm_setNodeParam;
-%rename(node_get_result)                            swmm_getNodeResult;
-%rename(node_get_pollutant)                         swmm_getNodePollut;
-%rename(node_get_total_inflow)                      swmm_getNodeTotalInflow;
-%rename(node_set_total_inflow)                      swmm_setNodeInflow;
-%rename(node_get_stats)                             swmm_getNodeStats;
-
-%rename(storage_get_stats)                          swmm_getStorageStats;
-
-%rename(outfall_set_stage)                          swmm_setOutfallStage;
-%rename(outfall_get_stats)                          swmm_getOutfallStats;
-
-%rename(link_get_type)                              swmm_getLinkType;
-%rename(link_get_connections)                       swmm_getLinkConnections;
-%rename(link_get_direction)                         swmm_getLinkDirection;
-%rename(link_get_parameter)                         swmm_getLinkParam;
-%rename(link_set_parameter)                         swmm_setLinkParam;
-%rename(link_get_result)                            swmm_getLinkResult;
-%rename(link_get_pollutant)                         swmm_getLinkPollut;
-%rename(link_set_target_setting)                    swmm_setLinkSetting;
-%rename(link_get_stats)                             swmm_getLinkStats;
-
-%rename(pump_get_stats)                             swmm_getPumpStats;
-
-%rename(subcatch_get_connection)                    swmm_getSubcatchOutConnection;
-%rename(subcatch_get_parameter)                     swmm_getSubcatchParam;
-%rename(subcatch_set_parameter)                     swmm_setSubcatchParam;
-%rename(subcatch_get_result)                        swmm_getSubcatchResult;
-%rename(subcatch_get_pollutant)                     swmm_getSubcatchPollut;
-%rename(subcatch_get_stats)                         swmm_getSubcatchStats;
-
-%rename(lid_usage_get_count)                        swmm_getLidUCount;
-%rename(lid_usage_get_parameter)                    swmm_getLidUParam;
-%rename(lid_usage_set_parameter)                    swmm_setLidUParam;
-%rename(lid_usage_get_option)                       swmm_getLidUOption;
-%rename(lid_usage_set_option)                       swmm_setLidUOption;
-%rename(lid_usage_get_flux_rate)                    swmm_getLidUFluxRates;
-%rename(lid_usage_get_result)                       swmm_getLidUResult;
-%rename(lid_control_get_overflow)                   swmm_getLidCOverflow;
-%rename(lid_control_get_parameter)                  swmm_getLidCParam;
-%rename(lid_control_set_parameter)                  swmm_setLidCParam;
-%rename(lid_group_get_result)                       swmm_getLidGResult;
-
-%rename(rain_get_precipitation)                     swmm_getGagePrecip;
-%rename(rain_set_precipitation)                     swmm_setGagePrecip;
+
+// LEAVE OTHER CANONICAL API CALLS ALONE 
+%rename(swmm_get_mass_balance)              swmm_getMassBalErr;
+%rename(swmm_get_version)                   swmm_getVersion;
+
+
+// NEW TOOLKIT API CALLS
+// Duplicates?
+%rename(project_get_index)                  swmm_project_findObject;
+//%rename(project_get_index)                  swmm_getObjectIndex;
+
+%rename(project_get_id)                     swmm_getObjectId;
+%rename(project_get_count)                  swmm_countObjects;
+
+
+// Duplicates?
+%rename(simulation_get_datetime)            swmm_getSimulationDateTime;
+%rename(simulation_get_current_datetime)    swmm_getCurrentDateTime;
+
+%rename(simulation_set_datetime)            swmm_setSimulationDateTime;
+%rename(simulation_get_setting)             swmm_getSimulationAnalysisSetting;
+%rename(simulation_get_parameter)           swmm_getSimulationParam;
+%rename(simulation_get_unit)                swmm_getSimulationUnit;
+
+
+%rename(node_get_type)                      swmm_getNodeType;
+%rename(node_get_parameter)                 swmm_getNodeParam;
+%rename(node_set_parameter)                 swmm_setNodeParam;
+%rename(node_get_result)                    swmm_getNodeResult;
+%rename(node_get_pollutant)                 swmm_getNodePollut;
+%rename(node_get_total_inflow)              swmm_getNodeTotalInflow;
+%rename(node_set_total_inflow)              swmm_setNodeInflow;
+%rename(node_get_stats)                     swmm_getNodeStats;
+
+
+%rename(storage_get_stats)                  swmm_getStorageStats;
+
+
+%rename(outfall_set_stage)                  swmm_setOutfallStage;
+%rename(outfall_get_stats)                  swmm_getOutfallStats;
+
+
+%rename(link_get_type)                      swmm_getLinkType;
+%rename(link_get_connections)               swmm_getLinkConnections;
+%rename(link_get_direction)                 swmm_getLinkDirection;
+%rename(link_get_parameter)                 swmm_getLinkParam;
+%rename(link_set_parameter)                 swmm_setLinkParam;
+%rename(link_get_result)                    swmm_getLinkResult;
+%rename(link_get_pollutant)                 swmm_getLinkPollut;
+%rename(link_set_target_setting)            swmm_setLinkSetting;
+%rename(link_get_stats)                     swmm_getLinkStats;
+
+
+%rename(pump_get_stats)                     swmm_getPumpStats;
+
+
+%rename(subcatch_get_connection)            swmm_getSubcatchOutConnection;
+%rename(subcatch_get_parameter)             swmm_getSubcatchParam;
+%rename(subcatch_set_parameter)             swmm_setSubcatchParam;
+%rename(subcatch_get_result)                swmm_getSubcatchResult;
+%rename(subcatch_get_pollutant)             swmm_getSubcatchPollut;
+%rename(subcatch_get_stats)                 swmm_getSubcatchStats;
+
+
+%rename(system_get_routing_totals)          swmm_getSystemRoutingTotals;
+%rename(system_get_runoff_totals)           swmm_getSystemRunoffTotals;
+
+
+%rename(lid_usage_get_count)                swmm_getLidUCount;
+%rename(lid_usage_get_parameter)            swmm_getLidUParam;
+%rename(lid_usage_set_parameter)            swmm_setLidUParam;
+%rename(lid_usage_get_option)               swmm_getLidUOption;
+%rename(lid_usage_set_option)               swmm_setLidUOption;
+%rename(lid_usage_get_flux_rate)            swmm_getLidUFluxRates;
+%rename(lid_usage_get_result)               swmm_getLidUResult;
+%rename(lid_control_get_overflow)           swmm_getLidCOverflow;
+%rename(lid_control_get_parameter)          swmm_getLidCParam;
+%rename(lid_control_set_parameter)          swmm_setLidCParam;
+%rename(lid_group_get_result)               swmm_getLidGResult;
+
+
+%rename(raingage_get_precipitation)         swmm_getGagePrecip;
+%rename(raingage_set_precipitation)         swmm_setGagePrecip;
+
+
+%rename(swmm_version_info)                  swmm_getVersionInfo;
diff --git a/swmm-toolkit/src/swmm/toolkit/stats_typemaps.i b/swmm-toolkit/src/swmm/toolkit/stats_typemaps.i
@@ -1,4 +1,12 @@
-
+/*
+ *  stats_typemaps.i - SWIG interface description file for swmm structs
+ *
+ *  Created:    11/16/2020
+ *  Updated:
+ *
+ *  Author:     See AUTHORS
+ * 
+*/
 
 
 %define %statsmaps(Type)
diff --git a/swmm-toolkit/src/swmm/toolkit/toolkit_enum.py b/swmm-toolkit/src/swmm/toolkit/toolkit_enum.py
@@ -1,13 +1,11 @@
 #
 #  output_enum.py -
 #
-#  Created: February 21, 2020
+#  Created:   February 21, 2020
 #  Updated:
 #
-#  Author:     Michael E. Tryby
-#              US EPA - ORD/CESER
-#  Author:     Jennifer Wu
-#              Xylem Inc.
+#  Author:    See AUTHORS
+#
 
 from aenum import Enum, IntEnum
 
diff --git a/swmm-toolkit/tests/test_metadata.py b/swmm-toolkit/tests/test_metadata.py
@@ -5,8 +5,7 @@
 #   Created:  Apr 8, 2020
 #   Modified: Apr 20, 2020
 #
-#   Author: Michael E. Tryby
-#           US EPA - ORD/CESER
+#   Author:    See AUTHORS
 #
 #   Unit testing for SWMM output metadata using pytest.
 #
diff --git a/swmm-toolkit/tests/test_output.py b/swmm-toolkit/tests/test_output.py
@@ -4,8 +4,7 @@
 #   Created: Aug 7, 2018
 #   Updated: Apr 20, 2020
 #
-#   Author: Michael E. Tryby
-#           US EPA - ORD/NRMRL
+#   Author:  See AUTHORS
 #
 #   Unit testing for SWMM Output API using pytest.
 #
diff --git a/swmm-toolkit/tests/test_solver.py b/swmm-toolkit/tests/test_solver.py
diff --git a/swmm-toolkit/tests/test_stats.py b/swmm-toolkit/tests/test_stats.py
diff --git a/swmm-toolkit/tools/relocate.zsh b/swmm-toolkit/tools/relocate.zsh

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +# Authors ordered by first contribution
++
 +Michael Tryby <[email protected]> (public domain)
 +Jennifer Wu <[email protected]>
 +Caleb Buahin <[email protected]>
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,7 @@`
`4`	`4`	`# Created: Feb 6, 2020`
`5`	`5`	`# Modified May 7, 2020`
`6`	`6`	`#`
`7`		`-# Author: Michael E. Tryby`
`8`		`-# US EPA ORD/CESER`
	`7`	`+# Author: See AUTHORS`
`9`	`8`	`#`
`10`	`9`
`11`	`10`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,7 @@`
`4`	`4`	`# Created: Jul 2, 2018`
`5`	`5`	`# Updated: May 7, 2020`
`6`	`6`	`#`
`7`		`-# Author: Michael E. Tryby`
`8`		`-# US EPA - ORD/NRMRL`
	`7`	`+# Author: See AUTHORS`
`9`	`8`	`#`
`10`	`9`	`# Suggested Usage:`
`11`	`10`	`# python setup.py build`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,7 @@`
`4`	`4`	`# Created: Feb 6, 2020`
`5`	`5`	`# Updated: May 6, 2020`
`6`	`6`	`#`
`7`		`-# Author: Michael E. Tryby`
`8`		`-# US EPA ORD/CESER`
	`7`	`+# Author: See AUTHORS`
`9`	`8`	`#`
`10`	`9`
`11`	`10`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,7 @@`
`6`	`6`	`# Created: Aug 9, 2018`
`7`	`7`	`# Updated: May 20, 2020`
`8`	`8`	`#`
`9`		`-# Author: Michael E. Tryby`
`10`		`-# US EPA - ORD/NRMRL`
	`9`	`+# Author: See AUTHORS`
`11`	`10`	`#`
`12`	`11`
`13`	`12`	`'''`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,7 @@`
`4`	`4`	`* Created: November 3, 2017`
`5`	`5`	`* Updated: February 21, 2020`
`6`	`6`	`*`
`7`		`- * Author: Michael E. Tryby`
`8`		`- * US EPA - ORD/NRMRL`
	`7`	`+ * Author: See AUTHORS`
`9`	`8`	`*`
`10`	`9`	`*/`
`11`	`10`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,10 @@`
`1`	`1`	`#`
`2`	`2`	`# output_metadata.py -`
`3`	`3`	`#`
`4`		`-# Created: February 20, 2020`
	`4`	`+# Created: February 20, 2020`
`5`	`5`	`# Updated:`
`6`	`6`	`#`
`7`		`-# Author: Michael E. Tryby`
`8`		`-# US EPA - ORD/CESER`
	`7`	`+# Author: See AUTHORS`
`9`	`8`	`#`
`10`	`9`
`11`	`10`