erp outputs endpoint

CHANGELOG.md

@@ -28,6 +28,9 @@ Classify the change according to the following categories:
 
 ## Develop
 ### Minor Updates
+#### Added
+- `/erp/inputs` endpoint (calls `erp_help()`, same as `/erp/help`)
+- `/erp/outputs` endpoint that GETs the ERP output field info (calls `erp_outputs()`)
 #### Changed
 - Set **reopt_version** in **APIMeta** and **ERPMeta** programatically based on actual REopt.jl package version in Julia environment instead of hardcoded so doesn't need to be updated by hand
 

resilience_stats/tests/test_erp.py

@@ -16,6 +16,8 @@ def setUp(self):
         self.reopt_base_erp = '/v3/erp/'
         self.reopt_base_erp_results = '/v3/erp/{}/results/'
         self.reopt_base_erp_help = '/v3/erp/help/'
+        self.reopt_base_erp_inputs = '/v3/erp/inputs/'
+        self.reopt_base_erp_outputs = '/v3/erp/outputs/'
         self.reopt_base_erp_chp_defaults = '/v3/erp/chp_defaults/?prime_mover={0}&is_chp={1}&size_kw={2}'
         self.post_sim_gens_batt_pv_wind = os.path.join('resilience_stats', 'tests', 'ERP_sim_gens_batt_pv_wind_post.json')
         self.post_sim_large_stor = os.path.join('resilience_stats', 'tests', 'ERP_sim_large_stor_post.json')
@@ -42,6 +44,12 @@ def get_results_sim(self, run_uuid):
     def get_help(self):
         return self.api_client.get(self.reopt_base_erp_help)
 
+    def get_inputs(self):
+        return self.api_client.get(self.reopt_base_erp_inputs)
+
+    def get_outputs(self):
+        return self.api_client.get(self.reopt_base_erp_outputs)
+
     def get_chp_defaults(self, prime_mover, is_chp, size_kw):
         return self.api_client.get(
             self.reopt_base_erp_chp_defaults.format(prime_mover, is_chp, size_kw),
@@ -184,14 +192,22 @@ def test_erp_with_no_opt(self):
         resp = self.get_results_sim(erp_run_uuid)
         self.assertHttpOK(resp)
 
-    def test_erp_help_view(self):
+    def test_erp_help_views(self):
         """
         Tests hiting the erp/help url to get defaults and other info about inputs
         """
 
         resp = self.get_help()
         self.assertHttpOK(resp)
         resp = json.loads(resp.content)
+
+        resp = self.get_inputs()
+        self.assertHttpOK(resp)
+        resp = json.loads(resp.content)
+
+        resp = self.get_outputs()
+        self.assertHttpOK(resp)
+        resp = json.loads(resp.content)
 
         resp = self.get_chp_defaults("recip_engine", True, 10000)
         self.assertHttpOK(resp)

resilience_stats/urls_v3plus.py

@@ -6,5 +6,7 @@
 urlpatterns = [
     re_path(r'^erp/(?P<run_uuid>[0-9a-f-]+)/results/?$', views.erp_results),
     re_path(r'^erp/help/?$', views.erp_help),
+    re_path(r'^erp/inputs/?$', views.erp_inputs),
+    re_path(r'^erp/outputs/?$', views.erp_outputs),
     re_path(r'^erp/chp_defaults/?$', views.erp_chp_prime_gen_defaults),
 ]

resilience_stats/views.py

@@ -104,23 +104,58 @@ def erp_results(request, run_uuid):
         resp['status'] = 'Error'
         return JsonResponse(resp, status=500)
 
+def get_erp_inputs_info():
+    d = dict()
+    d["reopt_run_uuid"] = ERPMeta.info_dict(ERPMeta)["reopt_run_uuid"]
+    # do models need to be passed in as arg?
+    d[ERPOutageInputs.key] = ERPOutageInputs.info_dict(ERPOutageInputs)
+    d[ERPPVInputs.key] = ERPPVInputs.info_dict(ERPPVInputs)
+    d[ERPWindInputs.key] = ERPWindInputs.info_dict(ERPWindInputs)
+    d[ERPElectricStorageInputs.key] = ERPElectricStorageInputs.info_dict(ERPElectricStorageInputs)
+    d[ERPGeneratorInputs.key] = ERPGeneratorInputs.info_dict(ERPGeneratorInputs)
+    d[ERPPrimeGeneratorInputs.key] = ERPPrimeGeneratorInputs.info_dict(ERPPrimeGeneratorInputs)
+    #TODO: add wind once implemented
+    return JsonResponse(d)
+
 def erp_help(request):
+    """
+    Served at host/erp/help
+    :param request: 
+    :return: JSON response with all erp inputs
+    """
     try:
-        d = dict()
-        d["reopt_run_uuid"] = ERPMeta.info_dict(ERPMeta)["reopt_run_uuid"]
-        # do models need to be passed in as arg?
-        d[ERPOutageInputs.key] = ERPOutageInputs.info_dict(ERPOutageInputs)
-        d[ERPPVInputs.key] = ERPPVInputs.info_dict(ERPPVInputs)
-        d[ERPWindInputs.key] = ERPWindInputs.info_dict(ERPWindInputs)
-        d[ERPElectricStorageInputs.key] = ERPElectricStorageInputs.info_dict(ERPElectricStorageInputs)
-        d[ERPGeneratorInputs.key] = ERPGeneratorInputs.info_dict(ERPGeneratorInputs)
-        d[ERPPrimeGeneratorInputs.key] = ERPPrimeGeneratorInputs.info_dict(ERPPrimeGeneratorInputs)
-        #TODO: add wind once implemented
-        return JsonResponse(d)
+        resp = get_erp_inputs_info()
+        return resp
 
     except Exception as e:
         return JsonResponse({"Error": "Unexpected error in ERP help endpoint: {}".format(e.args[0])}, status=500)
 
+def erp_inputs(request):
+    """
+    Served at host/erp/inputs
+    :param request: 
+    :return: JSON response with all erp inputs
+    """
+    try:
+        resp = get_erp_inputs_info()
+        return resp
+
+    except Exception as e:
+        return JsonResponse({"Error": "Unexpected error in ERP inputs endpoint: {}".format(e.args[0])}, status=500)
+
+def erp_outputs(request):
+    """
+    Served at host/erp/outputs
+    :return: JSON response with all erp outputs
+    """
+
+    try:
+        d = ERPOutputs.info_dict(ERPOutputs)
+        return JsonResponse(d)
+
+    except Exception as e:
+        return JsonResponse({"Error": "Unexpected error in ERP outputs endpoint: {}".format(e.args[0])}, status=500)
+
 def erp_chp_prime_gen_defaults(request):
     prime_mover = str(request.GET.get('prime_mover'))
     is_chp = bool(request.GET.get('is_chp'))