diff --git a/flow/core/kernel/vehicle/base.py b/flow/core/kernel/vehicle/base.py index 599afe3d5..706504027 100644 --- a/flow/core/kernel/vehicle/base.py +++ b/flow/core/kernel/vehicle/base.py @@ -299,6 +299,7 @@ def get_num_not_departed(self): def get_fuel_consumption(selfself, veh_id, error=-1001): """Return the mpg / s of the specified vehicle. + Parameters ---------- veh_id : str or list of str diff --git a/flow/core/rewards.py b/flow/core/rewards.py index 829316424..f92fb9f3c 100755 --- a/flow/core/rewards.py +++ b/flow/core/rewards.py @@ -334,6 +334,7 @@ def energy_consumption(env, gain=.001): def veh_energy_consumption(env, veh_id, gain=.001): """Calculate power consumption of a vehicle. + Assumes vehicle is an average sized vehicle. The power calculated here is the lower bound of the actual power consumed by a vehicle. @@ -357,7 +358,8 @@ def veh_energy_consumption(env, veh_id, gain=.001): def miles_per_megajoule(env, veh_ids=None, gain=.001): - """Calculate miles per mega-joule of either a particular vehicle or the total average of all the vehilces. + """Calculate miles per mega-joule of either a particular vehicle or the total average of all the vehicles. + Assumes vehicle is an average sized vehicle. The power calculated here is the lower bound of the actual power consumed by a vehicle. @@ -398,7 +400,8 @@ def miles_per_megajoule(env, veh_ids=None, gain=.001): def miles_per_gallon(env, veh_ids=None, gain=.001): - """Calculate mpg of either a particular vehicle or the total average of all the vehilces. + """Calculate mpg of either a particular vehicle or the total average of all the vehicles. + Assumes vehicle is an average sized vehicle. The power calculated here is the lower bound of the actual power consumed by a vehicle.