Standardize model identifier names; Support datastacks for plugins

scripts/invest-autovalidate.py

@@ -11,6 +11,7 @@
 import unittest
 
 from natcap.invest import datastack
+from natcap.invest import models
 
 logging.basicConfig(level=logging.INFO)
 LOGGER = logging.getLogger('invest-autovalidate.py')
@@ -33,7 +34,7 @@ def test_exception_on_invalid_data(self):
             self.workspace, 'dummy.invs.json')
         with open(datastack_path, 'w') as file:
             file.write('"args": {"something": "else"},')
-            file.write('"model_name": natcap.invest.carbon')
+            file.write('"model_id": "carbon"')
         with self.assertRaises(ValueError):
             main(self.workspace)
 
@@ -43,7 +44,7 @@ def test_exception_on_workspace_dir(self):
             self.workspace, 'dummy.invs.json')
         with open(datastack_path, 'w') as file:
             file.write('"args": {"workspace_dir": "/home/foo"},')
-            file.write('"model_name": natcap.invest.carbon')
+            file.write('"model_id": "carbon"')
         with self.assertRaises(ValueError):
             main(self.workspace)
 
@@ -67,25 +68,25 @@ def main(sampledatadir):
         raise ValueError(f'no json files found in {sampledatadir}')
 
     for datastack_path in datastacks:
-        paramset = datastack.extract_parameter_set(datastack_path)
-        if paramset.model_name.split(".")[-1] in {
-                'delineateit', 'ndr', 'scenic_quality', 'sdr',
-                 'seasonal_water_yield', 'recreation'}:
+        if datastack_path.split(os.sep)[-2] in {'DelineateIt', 'NDR', 'ScenicQuality',
+                                            'SDR', 'Seasonal_Water_Yield', 'recreation'}:
             continue # avoid compiled modles for devoloped of plugin feature branch
+        paramset = datastack.extract_parameter_set(datastack_path)
         if 'workspace_dir' in paramset.args and \
                 paramset.args['workspace_dir'] != '':
             msg = (
-                '%s : workspace_dir should not be defined '
-                'for sample datastacks' % datastack_path)
+                f'{datastack_path} : workspace_dir should not be defined '
+                'for sample datastacks' )
             validation_messages += os.linesep + msg
             LOGGER.error(msg)
         else:
             paramset.args['workspace_dir'] = tempfile.mkdtemp()
-        model_module = importlib.import_module(name=paramset.model_name)
+        model_module = importlib.import_module(
+            name=models.model_id_to_pyname[paramset.model_id])
 
         model_warnings = []  # define here in case of uncaught exception.
         try:
-            LOGGER.info('validating %s ', os.path.abspath(datastack_path))
+            LOGGER.info(f'validating {os.path.abspath(datastack_path)}')
             model_warnings = getattr(
                 model_module, 'validate')(paramset.args)
         except AttributeError as err:

src/natcap/invest/annual_water_yield.py

@@ -106,7 +106,7 @@
 
 MODEL_SPEC = {
     "model_id": "annual_water_yield",
-    "model_name": gettext("Annual Water Yield"),
+    "model_title": gettext("Annual Water Yield"),
     "pyname": "natcap.invest.annual_water_yield",
     "userguide": "annual_water_yield.html",
     "aliases": ("hwy", "awy"),

src/natcap/invest/carbon.py

@@ -42,7 +42,7 @@
 
 MODEL_SPEC = {
     "model_id": "carbon",
-    "model_name": gettext("Carbon Storage and Sequestration"),
+    "model_title": gettext("Carbon Storage and Sequestration"),
     "pyname": "natcap.invest.carbon",
     "userguide": "carbonstorage.html",
     "aliases": (),

src/natcap/invest/cli.py

@@ -54,7 +54,7 @@ def build_model_list_table(locale_code):
     # Adding 3 to max alias name length for the parentheses plus some padding.
     max_alias_name_length = max(len(', '.join(
         spec['aliases'])) for spec in models.model_id_to_spec.values()) + 3
-    template_string = '    {model_id} {aliases} {model_name}'
+    template_string = '    {model_id} {aliases} {model_title}'
     strings = [translation.gettext('Available models:')]
     for model_id, model_spec in models.model_id_to_spec.items():
 
@@ -65,7 +65,7 @@ def build_model_list_table(locale_code):
         strings.append(template_string.format(
             model_id=model_id.ljust(max_model_id_length),
             aliases=alias_string.ljust(max_alias_name_length),
-            model_name=translation.gettext(model_spec['model_name'])))
+            model_title=translation.gettext(model_spec['model_title'])))
     return '\n'.join(strings) + '\n'
 
 
@@ -94,8 +94,8 @@ def build_model_list_json(locale_code):
 
     json_object = {}
     for model_id, model_spec in models.model_id_to_spec.items():
-        json_object[translation.gettext(model_spec['model_name'])] = {
-            'model_name': model_id,
+        json_object[model_id] = {
+            'model_title': translation.gettext(model_spec['model_title']),
             'aliases': model_spec['aliases']
         }
 
@@ -159,7 +159,7 @@ def export_to_python(target_filepath, model_id, args_dict=None):
         py_file.write(script_template.format(
             invest_version=natcap.invest.__version__,
             today=datetime.datetime.now().strftime('%c'),
-            model_title=models.model_id_to_spec[model_id]['model_name'],
+            model_title=models.model_id_to_spec[model_id]['model_title'],
             pyname=models.model_id_to_pyname[model_id],
             model_args=args))
 
@@ -395,7 +395,7 @@ def main(user_args=None):
             # reload validation module first so it's also in the correct language
             importlib.reload(importlib.import_module('natcap.invest.validation'))
             model_module = importlib.reload(importlib.import_module(
-                name=parsed_datastack.model_name))
+                name=models.model_id_to_pyname[parsed_datastack.model_id]))
 
             try:
                 validation_result = model_module.validate(parsed_datastack.args)
@@ -470,12 +470,14 @@ def main(user_args=None):
                         model_module.__name__, model_module)
 
             with utils.prepare_workspace(parsed_datastack.args['workspace_dir'],
-                                         name=parsed_datastack.model_name,
+                                         model_id=parsed_datastack.model_id,
                                          logging_level=log_level):
-                LOGGER.log(datastack.ARGS_LOG_LEVEL,
-                           'Starting model with parameters: \n%s',
-                           datastack.format_args_dict(parsed_datastack.args,
-                                                      parsed_datastack.model_name))
+                LOGGER.log(
+                    datastack.ARGS_LOG_LEVEL,
+                    'Starting model with parameters: \n%s',
+                    datastack.format_args_dict(
+                        parsed_datastack.args,
+                        parsed_datastack.model_id))
 
                 # We're deliberately not validating here because the user
                 # can just call ``invest validate <datastack>`` to validate.

src/natcap/invest/coastal_blue_carbon/coastal_blue_carbon.py

@@ -161,7 +161,7 @@
 
 MODEL_SPEC = {
     "model_id": "coastal_blue_carbon",
-    "model_name": gettext("Coastal Blue Carbon"),
+    "model_title": gettext("Coastal Blue Carbon"),
     "pyname": "natcap.invest.coastal_blue_carbon.coastal_blue_carbon",
     "userguide": "coastal_blue_carbon.html",
     "aliases": ("cbc",),

src/natcap/invest/coastal_blue_carbon/preprocessor.py

@@ -22,7 +22,7 @@
 
 MODEL_SPEC = {
     "model_id": "coastal_blue_carbon_preprocessor",
-    "model_name": gettext("Coastal Blue Carbon Preprocessor"),
+    "model_title": gettext("Coastal Blue Carbon Preprocessor"),
     "pyname": "natcap.invest.coastal_blue_carbon.preprocessor",
     "userguide": "coastal_blue_carbon.html",
     "aliases": ("cbc_pre",),

src/natcap/invest/coastal_vulnerability.py

@@ -145,7 +145,7 @@ def get_vector_colnames(vector_path):
 
 MODEL_SPEC = {
     "model_id": "coastal_vulnerability",
-    "model_name": gettext("Coastal Vulnerability"),
+    "model_title": gettext("Coastal Vulnerability"),
     "pyname": "natcap.invest.coastal_vulnerability",
     "userguide": "coastal_vulnerability.html",
     "aliases": ("cv",),

src/natcap/invest/crop_production_percentile.py

@@ -103,7 +103,7 @@
 
 MODEL_SPEC = {
     "model_id": "crop_production_percentile",
-    "model_name": gettext("Crop Production: Percentile"),
+    "model_title": gettext("Crop Production: Percentile"),
     "pyname": "natcap.invest.crop_production_percentile",
     "userguide": "crop_production.html",
     "aliases": ("cpp",),

src/natcap/invest/crop_production_regression.py

@@ -67,7 +67,7 @@
 
 MODEL_SPEC = {
     "model_id": "crop_production_regression",
-    "model_name": gettext("Crop Production: Regression"),
+    "model_title": gettext("Crop Production: Regression"),
     "pyname": "natcap.invest.crop_production_regression",
     "userguide": "crop_production.html",
     "aliases": ("cpr",),