Merge pull request #155 from NREL/jdh/update-docs

Jdh/update docs

docs/source/inputs.md

@@ -39,11 +39,6 @@ In addition to the scenario config yaml file, each scenario has several other fi
 ```{include} ../../nrel/hive/resources/scenarios/denver_downtown/fleets/README.md
 ```
 
-### Geofence
-
-```{include} ../../nrel/hive/resources/scenarios/denver_downtown/geofence/README.md
-```
-
 ### Mechatronics
 
 ```{include} ../../nrel/hive/resources/scenarios/denver_downtown/mechatronics/README.md
@@ -76,7 +71,7 @@ In addition to the scenario config yaml file, each scenario has several other fi
 
 ### Vehicles
 
-```{include} ../../nrel/hive/resources/scenarios/denver_downtown/stations/README.md
+```{include} ../../nrel/hive/resources/scenarios/denver_downtown/vehicles/README.md
 ```
 
 ## Global Config

nrel/hive/config/input.py

@@ -25,7 +25,6 @@ class Input(NamedTuple):
     geofence_file: Optional[str] = None
     rate_structure_file: Optional[str] = None
     charging_price_file: Optional[str] = None
-    demand_forecast_file: Optional[str] = None
     fleets_file: Optional[str] = None
 
     @classmethod
@@ -108,15 +107,6 @@ def from_dict(cls, d: Dict, scenario_file_path: Path, cache: Optional[Dict]) ->
             if d.get("charging_price_file")
             else None
         )
-        demand_forecast_file = (
-            fs.construct_scenario_asset_path(
-                d["demand_forecast_file"],
-                scenario_directory,
-                "demand_forecast",
-            )
-            if d.get("demand_forecast_file")
-            else None
-        )
         fleets_file = (
             fs.construct_scenario_asset_path(d["fleets_file"], scenario_directory, "fleets")
             if d.get("fleets_file")
@@ -137,7 +127,6 @@ def from_dict(cls, d: Dict, scenario_file_path: Path, cache: Optional[Dict]) ->
             "geofence_file": geofence_file,
             "rate_structure_file": rate_structure_file,
             "charging_price_file": charging_price_file,
-            "demand_forecast_file": demand_forecast_file,
             "fleets_file": fleets_file,
         }
 
@@ -164,7 +153,6 @@ def from_dict(cls, d: Dict, scenario_file_path: Path, cache: Optional[Dict]) ->
             geofence_file=geofence_file,
             rate_structure_file=rate_structure_file,
             charging_price_file=charging_price_file,
-            demand_forecast_file=demand_forecast_file,
             fleets_file=fleets_file,
         )
 

nrel/hive/resources/defaults/hive_config.yaml

@@ -4,7 +4,6 @@ input:
   geofence_file: null                           # default is to have no geofencing
   rate_structure_file: null                     # default is $0.00 for all services
   charging_price_file: null                     # default is $0.00 for any charging
-  demand_forecast_file: null                    # default is no demand forecasting
 sim:
   timestep_duration_seconds: 60                 # default is to advance time 1 minute between dispatcher updates
   sim_h3_resolution: 15                         # default is to store GeoIds at h3 resolution 15 (approx 1 meter hexes)

nrel/hive/resources/mock_lobster.py

@@ -490,7 +490,6 @@ def mock_config(
             "rate_structure_file": "rate_structure.csv",
             "mechatronics_file": "mechatronics.yaml",
             "geofence_file": "downtown_denver.geojson",
-            "demand_forecast_file": "denver_demand.csv",
         }
     test_output_directory = tempfile.TemporaryDirectory()
     conf_without_temp_dir = HiveConfig.build(

nrel/hive/resources/scenarios/denver_downtown/chargers/README.md

@@ -1,4 +1,4 @@
-Chargers are specified as one charger per line with the following fields:
+Chargers are specified as one charger per csv line with the following fields:
 
 - `charger_id`: the unique identifier of the charger type
 - `energy_type`: the type of energy (electric | gasoline)

nrel/hive/resources/scenarios/denver_downtown/charging_prices/README.md

@@ -1,4 +1,4 @@
-Charging prices can be specified in two different ways:
+Charging prices are specified in a csv file and can be specified two different ways:
 
 1. Price per station with the following fields:
     - `time`: the time when the price becomes valid (allows for varible price schemes)