Groundwork for DB Version 3.1 and Unit Checking

README.md

@@ -64,9 +64,9 @@ is (for Utopia as an example):
 ```
 (venv) $ sqlite3 utopia.sqlite < utopia.sql
 ```
-- Converting legacy db's to Version 3 can be done with the included database migration tool.  Users who use this
+- Converting legacy db's to Version 3.0 can be done with the included database migration tool.  Users who use this
 tool are advised to carefully review the console outputs during conversion to ensure accuracy and check the 
-converted database carefully.  The migration tool will build an empty new Version 3 database and move data from
+converted database carefully.  The migration tool will build an empty new Version 3.0 database and move data from
 the old database, preserving the legacy database in place.  The command can be run from the top level of the 
 project and needs pointers to the target database and the Version 3 schema file.  A typical execution from top level
 should look like:
@@ -78,6 +78,10 @@ should look like:
 directory as described above using the `sqlite3` command.  The "minimal" version excludes some of the group
 parameters and is recommended as a starting point for entry-level models.  It can be upgraded to the full set of
 tables by executing the full schema SQL command on the resulting database later, which will add the missing tables.
+- Users wishing to use the optional "Unit Checking" functionality described in the documentation need to build from or
+transition to a version 3.1 database.  A second utility is provided to assist with this process and is run
+similarly to the migration utility described above.  The version 3.1 utility only accepts a source database
+that is already version 3.0 format.
 
 ## Config Files
 
@@ -91,6 +95,7 @@ and has all parameters in it.  It can be copied/renamed, etc.
 | Temoa Mode             | The execution mode.  See note below on currently supported modes                                           |
 | Input/Output DB        | The source (and optionally diffent) output database.  Note for myopic, MGA input must be same as output    |
 | Price Checking         | Run the "price checker" on the built model to look for costing deficiencies and log them                   |
+| Units Checking         | Run the "units checker" on the source (and destination) databases and document anomalies with units        |
 | Source Tracing         | Check the integrity of the commodity flow network in every region-period combination.  Required for Myopic |
 | Plot Commodity Network | Produce HTML (viewable in any browser) displays of the networks built (see note at bottom)                 |
 | Solver                 | The exact name of the solver executable to call                                                            |

data_files/example_dbs/morris_utopia.sql

@@ -1020,7 +1020,7 @@ CREATE TABLE MinNewCapacityShare
         REFERENCES Technology (tech),
     group_name     TEXT
         REFERENCES TechGroup (group_name),
-    max_proportion REAL,
+    min_proportion REAL,
     notes          TEXT,
     PRIMARY KEY (region, period, tech, group_name)
 );

data_files/example_dbs/stepped_demand.sql

@@ -1230,7 +1230,7 @@ CREATE TABLE MinNewCapacityShare
         REFERENCES Technology (tech),
     group_name     TEXT
         REFERENCES TechGroup (group_name),
-    max_proportion REAL,
+    min_proportion REAL,
     notes          TEXT,
     PRIMARY KEY (region, period, tech, group_name)
 );

data_files/example_dbs/utopia.sql

@@ -1208,7 +1208,7 @@ CREATE TABLE MinNewCapacityShare
         REFERENCES Technology (tech),
     group_name     TEXT
         REFERENCES TechGroup (group_name),
-    max_proportion REAL,
+    min_proportion REAL,
     notes          TEXT,
     PRIMARY KEY (region, period, tech, group_name)
 );

data_files/my_configs/config_sample.toml

@@ -38,6 +38,10 @@ output_database = "data_files/example_dbs/utopia.sqlite"
 # Strongly recommended
 price_check = true
 
+# check the units in the source/destination databases for units consistency.  Errors
+# are reported in log file and units_check.txt in output folder
+units_check = true
+
 # Check the network connectivity for processes in the model.  Strongly
 # recommended to ensure proper performance.  Results are reported in log file
 # This requires that source commodities be marked with 's' in Commodity table

data_files/my_configs/morris_utopia.toml

@@ -35,6 +35,10 @@ output_database = "data_files/example_dbs/morris_utopia.sqlite"
 # Strongly recommended
 price_check = true
 
+# check the units in the source/destination databases for units consistency.  Errors
+# are reported in log file and units_check.txt in output folder
+units_check = true
+
 # Check the network connectivity for processes in the model.  Strongly
 # recommended to ensure proper performance.  Results are reported in log file
 # This requires that source commodities be marked with 's' in Commodity table

data_files/temoa_schema_minimal_v3.sql

@@ -346,7 +346,7 @@ CREATE TABLE IF NOT EXISTS OutputCurtailment
     period      INTEGER
         REFERENCES TimePeriod (period),
     season      TEXT
-        REFERENCES TimePeriod (period),
+        REFERENCES TimeSeason (season),
     tod         TEXT
         REFERENCES TimeOfDay (tod),
     input_comm  TEXT