Merge pull request #397 from NREL/ndr/minor-doc-fixes

Minor doc fixes

Author: nreinicke

docs/_toc.yml

@@ -16,6 +16,7 @@ parts:
       - file: examples/02_different_powertrains_example
       - file: examples/03_time_energy_tradeoff_example
       - file: examples/04_charging_stations_example
+      - file: examples/05_ambient_temperature_example
 
   - caption: User Reference
     chapters:

docs/examples/01_open_street_maps_example.py

@@ -45,10 +45,9 @@
 
 ```{note}
 In order to get the most accurate energy results from the routee-powertrain vehicle models, it's important to include road grade information since it plays a large factor in vehicle energy consumption.
-That being said, adding grade can be a big lift computationally. In our case, we pull digital elevation model (DEM) raster files from USGS and then use osmnx to append elevation and grade to the graph. If the graph is large, this can take a while to download and could take up a lot of disk space.
+That being said, adding grade can be a big lift computationally. In our case, we pull digital elevation model (DEM) raster files from USGS and then use osmnx to append elevation and grade to the graph. 
+If the graph is large, this can take a while to download and could take up a lot of disk space.
 So, we recommend that you include grade information in your graph but want to be clear about the requirements for doing so.
-
-If you do not wish to impute grade from node elevations, remove "grade" from the "phases" argument.
 ```
 """
 
@@ -289,15 +288,9 @@ def pretty_print(dict):
     shortest_time_result["route"]["cost"]["total_cost"]
     - least_energy_result["route"]["cost"]["total_cost"]
 )
-dist_unit = shortest_time_result["route"]["state_model"]["trip_distance"]["Distance"][
-    "output_unit"
-]
-time_unit = shortest_time_result["route"]["state_model"]["trip_time"]["Time"][
-    "output_unit"
-]
-enrg_unit = shortest_time_result["route"]["state_model"]["trip_energy"]["Energy"][
-    "output_unit"
-]
+dist_unit = shortest_time_result["route"]["state_model"]["trip_distance"]["output_unit"]
+time_unit = shortest_time_result["route"]["state_model"]["trip_time"]["output_unit"]
+enrg_unit = shortest_time_result["route"]["state_model"]["trip_energy"]["output_unit"]
 print(f" - distance: {dist_diff:.2f} {dist_unit} further with time-optimal")
 print(f" - time: {-time_diff:.2f} {time_unit} longer with energy-optimal")
 print(f" - energy: {enrg_diff:.2f} {enrg_unit} more with time-optimal")

docs/examples/05_ambient_temperature_example.py

@@ -61,7 +61,7 @@
 # %%
 temp_results = []
 for temp in [0, 15, 32, 50, 72, 90, 110]:
-    query["ambient_temperature"] = {"value": temp, "unit": "fahrenheit"} 
+    query["ambient_temperature"] = {"value": temp, "unit": "fahrenheit"}
     result = app.run(query)
     if "error" in result:
         print(result["error"])

python/nrel/routee/compass/io/generate_dataset.py

@@ -34,10 +34,9 @@
 
 class GeneratePipelinePhase(enum.Enum):
     GRAPH = 1
-    GRADE = 2
-    CONFIG = 3
-    POWERTRAIN = 4
-    CHARGING_STATIONS = 5
+    CONFIG = 2
+    POWERTRAIN = 3
+    CHARGING_STATIONS = 4
 
     @classmethod
     def default(cls) -> List[GeneratePipelinePhase]:
@@ -109,7 +108,7 @@ def generate_compass_dataset(
     g1 = ox.add_edge_speeds(g1, hwy_speeds=hwy_speeds, fallback=fallback, agg=agg)
     g1 = ox.add_edge_bearings(g1)
 
-    if GeneratePipelinePhase.GRADE in phases:
+    if GeneratePipelinePhase.POWERTRAIN in phases:
         log.info("adding grade information")
         g1 = add_grade_to_graph(
             g1, resolution_arc_seconds=raster_resolution_arc_seconds
@@ -198,7 +197,7 @@ def replace_id(vertex_uuid: pd.Index) -> pd.Series[int]:
             compression="gzip",
         )
 
-    if GeneratePipelinePhase.GRADE in phases:
+    if GeneratePipelinePhase.POWERTRAIN in phases:
         e.grade.to_csv(
             output_directory / "edges-grade-enumerated.txt.gz",
             index=False,
@@ -211,10 +210,15 @@ def replace_id(vertex_uuid: pd.Index) -> pd.Series[int]:
         base_config_files = [
             "osm_default_distance.toml",
             "osm_default_speed.toml",
-            "osm_default_energy.toml",
-            "osm_default_energy_all_vehicles.toml",
-            "osm_default_temperature.toml",
         ]
+        if GeneratePipelinePhase.POWERTRAIN in phases:
+            base_config_files.extend(
+                [
+                    "osm_default_energy.toml",
+                    "osm_default_energy_all_vehicles.toml",
+                    "osm_default_temperature.toml",
+                ]
+            )
         if GeneratePipelinePhase.CHARGING_STATIONS in phases:
             base_config_files.append("osm_default_charging.toml")
         for filename in base_config_files:
@@ -223,12 +227,6 @@ def replace_id(vertex_uuid: pd.Index) -> pd.Series[int]:
             ) as init_toml_path:
                 with init_toml_path.open() as f:
                     init_toml: dict[str, Any] = tomlkit.load(f)
-                if filename == "osm_default_energy.toml":
-                    if GeneratePipelinePhase.GRADE in phases:
-                        init_toml["traversal"]["grade_table_input_file"] = (
-                            "edges-grade-enumerated.txt.gz"
-                        )
-                        init_toml["traversal"]["grade_table_grade_unit"] = "decimal"
             with open(output_directory / filename, "w") as f:
                 f.write(tomlkit.dumps(init_toml))