Skip to content

Ledger Output Parameters

Filter Options: - Category: - Units: - Data Type:

Ledger Output Parameters Category Full Form Units Description Data Type(s)
selection Scenario Selection Number Selection number of vehicle/scenario Union[int, str]
scenario_name Scenario Scenario Name Name of the selected scenario/vehicle str
model_year Scenario Vehicle Model Year Current year or Vehicle Model Year int
vehicle_life_yr Analysis Vehicle Life yr Number of years to calculate TCO for - generally the expected life of the vehicle in years int
tco_method Analysis TCO Calculation Method Choose TCO Calculation method between 'DIRECT' and 'EFFICIENCY'. 'DIRECT' method uses scenario.downtime_oppy_cost_dol_per_hr to estimate downtime opportunity costs while 'EFFICIENCY' method uses a time-based efficiency value to implicitly include downtime opportunity costs in the discounted_tco_dol. Defaults to 'DIRECT' if left blank. str
tco_per_year TCOCalc TCO Calculations Per Year List of dictionary of TCOCalc objects for each year of calculations. TCOCalc objects contain yearly total costs, and cost components for CapitalCosts, OperatingCosts, and OpportunityCosts list[TCOCalc]
discounted_total_cap_cost_dol CapitalCosts Discounted Total Capital Cost $ Discounted Total Capital Costs - Contains MSRP and Tax or Purchasing Downpayment. It is discounted for zero years, effectively not discounted due to the cost occuring during the start of lifecycle. float
discounted_total_oper_cost_dol OperatingCosts Discounted Total Operating Costs $ Discounted Total Operating Costs in dollars - Sum of discounted values of fuel expense, maintenance, insurance, purchasing, and fueling dwell labor float
discounted_downtime_oppy_cost_dol OpportunityCosts Discounted Total Opportunity Cost $ Discounted Total Opportunity Costs in dollars- sum of discounted values of lost payload capacity cost, fueling dwell opportunity cost, and maintenance & repair downtime opportunity cost float
discounted_tco_dol TCO Discounted Total Cost of Ownership $ Discounted total cost of ownership in dollars - calculated based on config.tco_method. For DIRECT method, it is the sum of discounted capital costs, operating costs, and opportunity costs per year. For EFFICIENCY method, it is estimated by taking productivity or value of downtime instead of adding downtime opportunity costs float
cumu_disc_tco_dol_per_yr TCO Cumulative Discounted Total Cost of Ownership $ Cumulative sum of discounted TCO per year in dollars presented as a vector of length=vehicle_life_yr list[float]
cumu_tco_dol_per_mi TCO Cumulative Total Cost of Ownership Per Mile $ Cumulative discounted TCO in dollars divided by cumulative vmt presented as a vector of length=vehicle_life_yr list[float]
cumu_levelized_tco_dol_per_mi TCO Cumulative Levelized Total Cost of Ownership Per Mile $ Cumulative discounted TCO in dollars divided by cumulative discounted VMT presented as a vector of length=vehicle_life_yr list[float]
total_vmt Scenario Total Vehicle Miles Traveled mi Sum of Vehicle Miles Traveled (scenario.vmt) for all years in vehicle_life_yr float
disc_total_vmt Scenario Discounted Total Vehicle Miles Traveled mi Sum of scenario.vmt discounted at the rate of scenario.discount_rate_pct_per_yr float
glider_cost_dol CapitalCosts Glider Cost $ Estimated glider component cost in dollars - contributes to MSRP float
fuel_converter_cost_dol CapitalCosts Fuel Converter Cost $ Estimated fuel converter component cost in dollars - contributes to MSRP float
fuel_storage_cost_dol CapitalCosts Fuel Storage Cost $ Estimated fuel storage component cost in dollars - contributes to MSRP float
motor_control_power_elecs_cost_dol CapitalCosts Motor Controller & Power Electronics Cost $ Estimated motor and power electronics component cost in dollars - contributes to MSRP float
plug_cost_dol CapitalCosts Plugin Charger Cost $ Estimated plugin charger component cost in dollars - contributes to MSRP float
battery_cost_dol CapitalCosts Battery Cost $ Estimated battery/ESS component cost in dollars - contributes to MSRP float
purchase_tax_dol CapitalCosts Purchase Tax $ Estimated purchased/excise tax in dollars - calculated from MSRP float
msrp_total_dol CapitalCosts Manufacturer's Suggester Retail Price $ Estimated manufacturer's suggested retail price in dollars - calculated from vehicle component costs float
purchasing_downpayment_dol CapitalCosts Purchasing Downpayment Cost $ Estimated purchasing downpayment in dollars. For loan or lease, it is calculated from scenario.purchasing_downpayment_pct and mrsp_total_dol+purchase_tax. For cash method, it is equal to mrsp_total_dol+purchase_tax float
residual_cost_dol CapitalCosts Residual Cost $ Estimated residual cost of vehicle in dollars (residual value is the negative of residual cost) float
total_fuel_cost_dol OperatingCosts Total Fuel Operating Cost $ Estimated fuel operating cost in dollars - calculated from energy consumption and fuel prices float
total_maintenance_cost_dol OperatingCosts Total Maintenance Operating Cost $ Estimated maintenance operating cost in dollars - calculated from VMT and scenario.maint_oper_cost_dol_per_mi float
total_purchasing_cost_dol OperatingCosts Total Purchasing Operating Cost $ Estimated purchasing cost - additional payments due to interest or rent fee for loan and lease methods respectively float
insurance_cost_dol OperatingCosts Insurance Cost $ Estimated insurance cost of vehicle in dollars - estimated from MSRP and scenario.insurance_rates_pct_per_yr float
fueling_dwell_labor_cost_dol OperatingCosts Fueling/Charging Dwell Labor Cost $ Estimated labor cost incurred during fueling/charging dwell time float
payload_capacity_cost_dol OpportunityCosts Lost Payload Capacity Opportunity Cost $ Lost payload capacity opportunity cost in dollars - estimated from payload_cap_cost_multiplier and estimated tco float
fueling_downtime_oppy_cost_dol OpportunityCosts Fueling/Charging Dwell Opportunity Cost $ Estimated opportunity cost associated with fueling/charging dwell time float
mr_downtime_oppy_cost_dol OpportunityCosts Maintenance Downtime Opportunity Cost $ Estimated labor cost incurred during maintenance & repair downtime float
discounted_downtime_oppy_cost_dol OpportunityCosts Discounted Total Downtime Opportunity Cost $ Estimated discounted opportunity cost for both fueling dwell time and M&R downtime in dollars - estimation is based on config.TCO_method float
total_fuel_used_gal_ge Energy Total Fuel Used Gallon Gasoline Equivalent GGE Estimated total fuel used in gallons gasoline equivalent - estimated from energy efficiency and distance traveled float
total_fuel_used_gal_de Energy Total Fuel Used Gallon Diesel Equivalent DGE Estimated total fuel used in diesels gasoline equivalent - estimated from energy efficiency and distance traveled float
mpgge Energy Miles Per Gallon Gasoline Equivalent mi/GGE Miles per Gallon of Gasoline Equivalent - from drivecycle simulation float
grid_mpgge Energy Grid Impact Fuel Economy mi/GGE Miles per Gallon of Gasoline Equivalent effect to grid - mpgge times charger efficiency float
mpgde Energy Miles Per Gallon Diesel Equivalent mi/DGE Miles per Gallon of Diesel Equivalent - from drivecycle simulation float
kwh_per_mi Energy Energy Per Distance km/mi Energy spent per mile of operation - estimated from drivecycle simulation float
payload_cap_cost_multiplier OpportunityCosts Lost Payload Capacity Multiplier Lost payload capacity opportunity cost factor - represents the fractionally extra vehicle required to compensate for reduced payload capacity compared to conventional vehicle - Currently only for Class 8 vehicles float
total_fueling_dwell_time_hr OpportunityCosts Fueling/Charging Dwell Time hr Total dwell time of vehicle due to fueling/charging - used to estimate downtime opportunity cost float
total_mr_downtime_hr OpportunityCosts Maintenance Downtime hr Total dwell time of vehicle due to maintenance & repair (planned, unplanned, and tire replacement) - used to estimate downtime opportunity cost float
total_downtime_hr OpportunityCosts Total Downtime hr Total downtime due to fueling/charging and maintenance events float