initial commit

Author: adfarth

CHANGELOG.md

@@ -26,6 +26,11 @@ Classify the change according to the following categories:
     ##### Removed
     ### Patches
 
+## gridRE
+### Minor Updates
+#### Changed
+- Changed v3 endpoint "cambium_emissions_profile" to "cambium_profile"
+
 ## v3.10.2
 ### Minor Updates
 ##### Changed

julia_src/http.jl

@@ -348,9 +348,9 @@ function avert_emissions_profile(req::HTTP.Request)
     return HTTP.Response(200, JSON.json(data))
 end
 
-function cambium_emissions_profile(req::HTTP.Request)
+function cambium_profile(req::HTTP.Request)
     d = JSON.parse(String(req.body))
-    @info "Getting Cambium CO2 emissions profile..."
+    @info "Getting emissions or clean energy data from Cambium..."
     data = Dict()
     error_response = Dict()
     try
@@ -360,7 +360,7 @@ function cambium_emissions_profile(req::HTTP.Request)
         lifetime = typeof(d["lifetime"]) == String ? parse(Int, d["lifetime"]) : d["lifetime"]
         load_year = typeof(d["load_year"]) == String ? parse(Int, d["load_year"]) : d["load_year"]
 
-        data = reoptjl.cambium_emissions_profile(;scenario= d["scenario"],
+        data = reoptjl.cambium_profile(;scenario= d["scenario"],
                                                 location_type = d["location_type"],  
                                                 latitude=latitude, 
                                                 longitude=longitude, 
@@ -597,7 +597,7 @@ HTTP.register!(ROUTER, "POST", "/erp", erp)
 HTTP.register!(ROUTER, "POST", "/ghpghx", ghpghx)
 HTTP.register!(ROUTER, "GET", "/chp_defaults", chp_defaults)
 HTTP.register!(ROUTER, "GET", "/avert_emissions_profile", avert_emissions_profile)
-HTTP.register!(ROUTER, "GET", "/cambium_emissions_profile", cambium_emissions_profile)
+HTTP.register!(ROUTER, "GET", "/cambium_profile", cambium_profile)
 HTTP.register!(ROUTER, "GET", "/easiur_costs", easiur_costs)
 HTTP.register!(ROUTER, "GET", "/simulated_load", simulated_load)
 HTTP.register!(ROUTER, "GET", "/absorption_chiller_defaults", absorption_chiller_defaults)

reoptjl/test/test_http_endpoints.py

@@ -231,8 +231,8 @@ def test_avert_emissions_profile_endpoint(self):
         self.assertTrue("error" in view_response)
 
 
-    def test_cambium_emissions_profile_endpoint(self):
-        # Call to the django view endpoint v3/cambium_emissions_profile which calls the http.jl endpoint
+    def test_cambium_profile_endpoint(self):
+        # Call to the django view endpoint v3/cambium_profile which calls the http.jl endpoint
         #case 1: location in CONUS (Seattle, WA)
         inputs = {
             "load_year": 2021,
@@ -245,7 +245,7 @@ def test_cambium_emissions_profile_endpoint(self):
             "metric_col": "lrmer_co2e",
             "grid_level": "enduse"
         }
-        resp = self.api_client.get(f'/v3/cambium_emissions_profile', data=inputs) 
+        resp = self.api_client.get(f'/v3/cambium_profile', data=inputs) 
         self.assertHttpOK(resp)
         view_response = json.loads(resp.content)
         self.assertEquals(view_response["metric_col"], "lrmer_co2e")
@@ -254,21 +254,21 @@ def test_cambium_emissions_profile_endpoint(self):
         #case 2: location off shore of NJ (works for AVERT, not Cambium)
         inputs["latitude"] = 39.034417
         inputs["longitude"] = -74.759292
-        resp = self.api_client.get(f'/v3/cambium_emissions_profile', data=inputs) 
+        resp = self.api_client.get(f'/v3/cambium_profile', data=inputs) 
         self.assertHttpBadRequest(resp)
         view_response = json.loads(resp.content)
         self.assertTrue("error" in view_response)
         #case 3: Honolulu, HI (works for AVERT but not Cambium)
         inputs["latitude"] = 21.3099
         inputs["longitude"] = -157.8581
-        resp = self.api_client.get(f'/v3/cambium_emissions_profile', data=inputs)
+        resp = self.api_client.get(f'/v3/cambium_profile', data=inputs)
         self.assertHttpBadRequest(resp) 
         view_response = json.loads(resp.content)
         self.assertTrue("error" in view_response)
         #case 4: location well outside of US (does not work)
         inputs["latitude"] = 0.0
         inputs["longitude"] = 0.0
-        resp = self.api_client.get(f'/v3/cambium_emissions_profile', data=inputs)
+        resp = self.api_client.get(f'/v3/cambium_profile', data=inputs)
         self.assertHttpBadRequest(resp) 
         view_response = json.loads(resp.content)
         self.assertTrue("error" in view_response)

reoptjl/urls.py

@@ -11,7 +11,7 @@
     re_path(r'^chp_defaults/?$', views.chp_defaults),
     re_path(r'^absorption_chiller_defaults/?$', views.absorption_chiller_defaults),
     re_path(r'^avert_emissions_profile/?$', views.avert_emissions_profile),
-    re_path(r'^cambium_emissions_profile/?$', views.cambium_emissions_profile),
+    re_path(r'^cambium_profile/?$', views.cambium_profile),
     re_path(r'^easiur_costs/?$', views.easiur_costs),
     re_path(r'^simulated_load/?$', views.simulated_load),
     re_path(r'^user/(?P<user_uuid>[0-9a-f-]+)/summary/?$', views.summary),

reoptjl/views.py

@@ -1452,7 +1452,7 @@ def avert_emissions_profile(request):
         log.error(debug_msg)
         return JsonResponse({"Error": "Unexpected Error. Please check your input parameters and contact [email protected] if problems persist."}, status=500)
 
-def cambium_emissions_profile(request):
+def cambium_profile(request):
     try:
         inputs = {
             "scenario": request.GET['scenario'], 
@@ -1471,7 +1471,7 @@ def cambium_emissions_profile(request):
             "julia"
         )
         http_jl_response = requests.get(
-            "http://" + julia_host + ":8081/cambium_emissions_profile/", 
+            "http://" + julia_host + ":8081/cambium_profile/", 
             json=inputs
         )
         response = JsonResponse(