Merge pull request #94 from staadecker/save_scenario

Add script to save new scenarios to the database

Author: pesap

docs/Database.md

@@ -41,8 +41,18 @@ The command to enter PostgreSQL while SSH'd into the server is `psql wecc`.
 
 ## Making changes to the database
 
-Whether it's adding data to the database or changing its schema, it's important
-to proceed carefully when making changes to the database. Always make sure to
+### Common operations
+
+Some database changes are common operations that are used repeatedly.
+For these operations, it's helpful to make a command line tool to make the process easy.
+
+For example, adding a scenario to the database is a common operation. Therefore, we have built
+the `switch db save_scenario` command to easily do this. (Run `switch db save_scenario --help` for details).
+
+### Custom operations
+
+When running custom operations on the database it's very important
+to proceed carefully. Always make sure to
 **test and keep track of your changes**.
 
 Here are the steps to make a change.
@@ -61,9 +71,7 @@ to the convention `YYYY-MM-DD_<script_name>`.
 5. Open a pull request to add your script to the repository (see [`docs/Contribute.md`](Contribute.md))
 so we can keep track of the changes that have been made.
 
-### Bigger changes
-
-Sometimes, it isn't feasible to have your entire change as a single SQL script.
+Note that sometimes, it isn't feasible to have your entire change as a single SQL script.
 One way to make bigger changes is to use a Python script. Use the same process
 as for the SQL scripts. That is save your Python scripts in the `/database` folder.
 

switch_model/tools/templates/config.yaml

@@ -21,6 +21,8 @@ get_inputs:
   #  the following parameters are optional and will override the defaults for that scenario
   #  this should only be used for preliminary exploration of scenarios or for testing
   #  if a scenario is part of research, it should be included in the database as a row in the scenarios table.
+  #
+  # -1 is equivalent to null
   #  study_timeframe_id:
   #  time_sample_id:
   #  demand_scenario_id:

switch_model/wecc/__main__.py

@@ -5,17 +5,22 @@
 from __future__ import print_function
 
 import argparse
+import importlib
 import sys
-import switch_model.wecc.sampling.cli as sample
+
+def get_module_runner(module):
+    def runner():
+        importlib.import_module(module).main()
+    return runner
 
 
 cmds = {
-    "sample": sample.main,
+    "sample": get_module_runner("switch_model.wecc.sampling.cli"),
+    "save_scenario": get_module_runner("switch_model.wecc.save_scenario"),
 }
 
-
 def main(args=None):
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(add_help=False)
     parser.add_argument("subcommand", choices=cmds.keys(), help="The possible switch subcommands")
 
     args, remaining_args = parser.parse_known_args(args)