Parameterized notebook examples

earthsim/__init__.py

@@ -0,0 +1,45 @@
+import param
+
+def params_from_kwargs(**kwargs):
+    """
+    Utility to promote keywords with literal values to the appropriate
+    parameter type with the specified default value unless the value is
+    already a parameter.
+    """
+    params = {}
+    for k, v in kwargs.items():
+        kws = dict(default=v)
+        if isinstance(v, param.Parameter):
+            params[k] = v
+        elif isinstance(v, bool):
+            params[k] = param.Boolean(**kws)
+        elif isinstance(v, int):
+            params[k] = param.Integer(**kws)
+        elif isinstance(v, float):
+            params[k] = param.Number(**kws)
+        elif isinstance(v, str):
+            params[k] = param.String(**kws)
+        elif isinstance(v, dict):
+            params[k] = param.Dict(**kws)
+        elif isinstance(v, tuple):
+            params[k] = param.Tuple(**kws)
+        elif isinstance(v, list):
+            params[k] = param.List(**kws)
+        elif isinstance(v, np.ndarray):
+            params[k] = param.Array(**kws)
+        else:
+            params[k] = param.Parameter(**kws)
+    return params
+
+
+def parameters(**kwargs):
+    """
+    Utility to easily define a parameterized class with a chosen set of
+    parameters specified as keyword arguments. The resulting object can
+    be used to parameterize a notebook, display corresponding widgets
+    with parambokeh and control the workflow from the command line.
+    """
+    name = kwargs.get('name', 'Parameters')
+    params = params_from_kwargs(**kwargs)
+    params['name'] = param.String(default=name)
+    return type(name, (param.Parameterized,), params)

earthsim/__main__.py

@@ -0,0 +1,43 @@
+"""
+Prototype of a param script that can set global_params via the
+appropriate environment variable to execute an arbitrary command.
+
+Example usage:
+
+param -cmd 'jupyter nbconvert --execute GSSHA_Workflow_Batched_Example2.ipynb' -p rain_intensity=25 -p rain_duration=3600
+"""
+
+import os
+import sys
+import json
+import argparse
+import subprocess
+from distutils import spawn
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-cmd',type=str)
+    parser.add_argument("-p", nargs=1, action='append')
+    args = parser.parse_args()
+    if args.p is None:
+        print('Please supply parameters using the -p flag')
+        sys.exit(1)
+
+    if args.cmd is None:
+        print('Please supply a command string using the -cmd flag')
+        sys.exit(1)
+
+    execute(args)
+
+def execute(args):
+    split_strings = dict(el[0].split('=') for el in args.p)
+    json_dict = {k:eval(v) for k,v in split_strings.items()}
+    env = os.environ.copy() # Required on windows
+    env['PARAM_JSON_INIT'] = json.dumps(json_dict)
+    cmd = args.cmd.split()
+    p = subprocess.Popen(cmd, env=env,
+                          stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    out, err = p.communicate()
+
+if __name__ == "__main__":
+    main()

earthsim/gssha/__init__.py

@@ -20,7 +20,7 @@ class Simulation(param.Parameterized):
 
     land_use_grid_id = param.Parameter(default='nlcd',precedence=0.3)
 
-    model_creator = param.ClassSelector(CreateModel,default=CreateGSSHAModel(),precedence=0.4)
+    model_creator = param.ClassSelector(CreateModel,default=CreateGSSHAModel(),precedence=-1)
 
     # TODO: switch to date range...
     simulation_start=param.Date(default=datetime(2017, 5 ,9),precedence=0.5)

earthsim/gssha/model.py

@@ -126,7 +126,7 @@ class CreateGSSHAModel(CreateModel):
     # created or else editing parameters on non-default options is
     # confusing.
     roughness = param.ClassSelector(RoughnessSpecification,default=UniformRoughness(),doc="""
-        Method for specifying roughness""") 
+        Method for specifying roughness""", precedence=-1) 
 
     out_hydrograph_write_frequency = param.Number(default=10, bounds=(1,60), doc="""
        Frequency of writing to hydrograph (minutes). Sets HYD_FREQ card. Required for new model.""", precedence=0.8)

environment.yml

@@ -9,6 +9,7 @@ channels:
     - defaults
 dependencies:
     - python>=3.5
+    - lancet
     - fiona
     - rasterio
     - gdal