4.1. bca_tool_code package

4.1.1. Subpackages

• 4.1.1.1. bca_tool_code.engine_cost_modules package
  • 4.1.1.1.1. Submodules
  • 4.1.1.1.2. bca_tool_code.engine_cost_modules.engine_package_cost module
    • calc_avg_package_cost_per_step()
    • calc_package_cost()
  • 4.1.1.1.3. bca_tool_code.engine_cost_modules.indirect_cost module
    • calc_project_markup_value()
    • calc_indirect_cost()
    • calc_indirect_cost_new_warranty()
  • 4.1.1.1.4. bca_tool_code.engine_cost_modules.tech_cost module
    • calc_tech_cost()
• 4.1.1.2. bca_tool_code.engine_input_modules package
  • 4.1.1.2.1. Submodules
  • 4.1.1.2.2. bca_tool_code.engine_input_modules.engine_learning_scalers module
    • EngineLearningScalers
      • EngineLearningScalers.__init__()
      • EngineLearningScalers.init_from_file()
      • EngineLearningScalers.get_seedvolume_factor()
      • EngineLearningScalers.calc_learning_effect()
• 4.1.1.3. bca_tool_code.general_input_modules package
  • 4.1.1.3.1. Submodules
  • 4.1.1.3.2. bca_tool_code.general_input_modules.average_speed module
    • AverageSpeed
      • AverageSpeed.__init__()
      • AverageSpeed.init_from_file()
      • AverageSpeed.get_attribute_value()
  • 4.1.1.3.3. bca_tool_code.general_input_modules.cost_factors module
    • CostFactors
      • CostFactors.__init__()
      • CostFactors.init_from_file()
      • CostFactors.get_factors()
  • 4.1.1.3.4. bca_tool_code.general_input_modules.def_prices module
    • DefPrices
      • DefPrices.__init__()
      • DefPrices.init_from_file()
      • DefPrices.get_price()
  • 4.1.1.3.5. bca_tool_code.general_input_modules.deflators module
    • Deflators
      • Deflators.__init__()
      • Deflators.init_from_file()
      • Deflators.deflator_df()
      • Deflators.calc_adjustment_factors()
      • Deflators.convert_dollars_to_analysis_basis()
  • 4.1.1.3.6. bca_tool_code.general_input_modules.fuel_prices module
    • FuelPrices
      • FuelPrices.__init__()
      • FuelPrices.init_from_file()
      • FuelPrices.get_price()
      • FuelPrices.aeo_dollars()
      • FuelPrices.select_aeo_table_rows()
      • FuelPrices.row_dict()
      • FuelPrices.melt_df()
      • FuelPrices.get_prices_from_file()
  • 4.1.1.3.7. bca_tool_code.general_input_modules.general_functions module
    • inputs_filenames()
    • get_file_datetime()
    • read_input_file()
    • save_dict()
    • save_dict_return_df()
  • 4.1.1.3.8. bca_tool_code.general_input_modules.general_inputs module
    • GeneralInputs
      • GeneralInputs.__init__()
      • GeneralInputs.init_from_file()
      • GeneralInputs.get_attribute_value()
  • 4.1.1.3.9. bca_tool_code.general_input_modules.input_files module
    • InputFiles
      • InputFiles.input_files_df
      • InputFiles.input_files_pathlist
      • InputFiles.__init__()
      • InputFiles.init_from_file()
      • InputFiles.get_filename()
      • InputFiles.update_pathlist()
  • 4.1.1.3.10. bca_tool_code.general_input_modules.markups module
    • Markups
      • Markups.__init__()
      • Markups.init_from_file()
      • Markups.get_attribute_value()
      • Markups.get_attribute_values()
      • Markups.update_contribution_factors()
      • Markups.get_contribution_factors_data()
  • 4.1.1.3.11. bca_tool_code.general_input_modules.moves_adjustments module
    • MovesAdjustments
      • MovesAdjustments.__init__()
      • MovesAdjustments.init_from_file()
      • MovesAdjustments.get_attribute_value()
  • 4.1.1.3.12. bca_tool_code.general_input_modules.options module
    • Options
      • Options.__init__()
      • Options.init_from_file()
      • Options.get_option_name()
      • Options.create_option_id()
      • Options.create_option_name()
  • 4.1.1.3.13. bca_tool_code.general_input_modules.piece_costs module
    • PieceCosts
      • PieceCosts.__init__()
      • PieceCosts.init_from_file()
      • PieceCosts.get_start_year_cost()
      • PieceCosts.update_package_cost_by_step()
      • PieceCosts.get_package_cost_by_standardyear_id()
  • 4.1.1.3.14. bca_tool_code.general_input_modules.runtime_options module
    • RuntimeOptions
      • RuntimeOptions.__init__()
      • RuntimeOptions.init_from_file()
      • RuntimeOptions.get_attribute_value()
      • RuntimeOptions.set_runtime_options()
      • RuntimeOptions.get_runtime_options()
  • 4.1.1.3.15. bca_tool_code.general_input_modules.tech_penetrations module
    • TechPenetrations
      • TechPenetrations.__init__()
      • TechPenetrations.init_from_file()
      • TechPenetrations.get_attribute_value()
  • 4.1.1.3.16. bca_tool_code.general_input_modules.useful_life module
    • UsefulLife
      • UsefulLife.__init__()
      • UsefulLife.init_from_file()
      • UsefulLife.get_attribute_value()
  • 4.1.1.3.17. bca_tool_code.general_input_modules.warranty module
    • Warranty
      • Warranty.__init__()
      • Warranty.init_from_file()
      • Warranty.get_attribute_value()
  • 4.1.1.3.18. bca_tool_code.general_input_modules.warranty_base_costs module
    • BaseWarrantyCosts
      • BaseWarrantyCosts.__init__()
      • BaseWarrantyCosts.init_from_file()
      • BaseWarrantyCosts.get_warranty_cost()
  • 4.1.1.3.19. bca_tool_code.general_input_modules.warranty_extended module
    • WarrantyExtended
      • WarrantyExtended.__init__()
      • WarrantyExtended.init_from_file()
      • WarrantyExtended.get_scaler()
      • WarrantyExtended.get_required_miles_with_share()
      • WarrantyExtended.get_share()
  • 4.1.1.3.20. bca_tool_code.general_input_modules.warranty_new_tech_adj_factor module
    • WarrantyNewTechAdj
      • WarrantyNewTechAdj.__init__()
      • WarrantyNewTechAdj.init_from_file()
      • WarrantyNewTechAdj.get_attribute_value()
• 4.1.1.4. bca_tool_code.general_modules package
  • 4.1.1.4.1. Submodules
  • 4.1.1.4.2. bca_tool_code.general_modules.annual_summary module
    • AnnualSummary
      • AnnualSummary.__init__()
      • AnnualSummary.annual_summary()
      • AnnualSummary.get_attribute_value()
      • AnnualSummary.update_object_dict()
      • AnnualSummary.calc_annualized_value()
  • 4.1.1.4.3. bca_tool_code.general_modules.calc_deltas module
    • calc_deltas()
    • calc_deltas_weighted()
  • 4.1.1.4.4. bca_tool_code.general_modules.create_figures module
    • CreateFigures
      • CreateFigures.__init__()
      • CreateFigures.line_chart_args_by_option()
      • CreateFigures.line_chart_arg_by_options()
      • CreateFigures.create_figures()
  • 4.1.1.4.5. bca_tool_code.general_modules.discounting module
    • discount_values()
    • discount_value()
  • 4.1.1.4.6. bca_tool_code.general_modules.emission_cost module
    • calc_criteria_emission_cost()
    • calc_ghg_emission_cost()
  • 4.1.1.4.7. bca_tool_code.general_modules.emission_reduction module
    • calc_nox_reduction()
    • calc_thc_reduction()
  • 4.1.1.4.8. bca_tool_code.general_modules.estimated_age_at_event module
    • EstimatedAge
      • EstimatedAge.__init__()
      • EstimatedAge.calc_estimated_age()
      • EstimatedAge.get_attribute_value()
  • 4.1.1.4.9. bca_tool_code.general_modules.fleet module
    • Fleet
      • Fleet.__init__()
      • Fleet.create_vehicles()
      • Fleet.engine_sales()
      • Fleet.cumulative_engine_sales()
      • Fleet.cumulative_vehicle_sales()
      • Fleet.get_typical_vmt_per_year()
      • Fleet.update_object_dict()
  • 4.1.1.4.10. bca_tool_code.general_modules.sum_by_vehicle module
    • calc_sum_of_costs()
  • 4.1.1.4.11. bca_tool_code.general_modules.vehicle module
    • Vehicle
      • Vehicle.vehicle_df
      • Vehicle.attributes_to_adjust
      • Vehicle.year_id_min
      • Vehicle.year_id_max
      • Vehicle.year_ids
      • Vehicle.__init__()
      • Vehicle.set_vehicle_id()
      • Vehicle.set_engine_id()
      • Vehicle.set_age_id()
      • Vehicle.get_fueltype_name()
      • Vehicle.get_regclass_name()
      • Vehicle.get_sourcetype_name()
      • Vehicle.init_from_file()
      • Vehicle.get_age0_min_year()
      • Vehicle.define_attributes_to_adjust()
      • Vehicle.create_vehicle_df()
      • Vehicle.calc_odometer()
      • Vehicle.rename_attributes()
  • 4.1.1.4.12. bca_tool_code.general_modules.weighted_results module
    • create_weighted_cost_dict()
• 4.1.1.5. bca_tool_code.operation_input_modules package
  • 4.1.1.5.1. Submodules
  • 4.1.1.5.2. bca_tool_code.operation_input_modules.def_doserates module
    • DefDoseRates
      • DefDoseRates.__init__()
      • DefDoseRates.init_from_file()
      • DefDoseRates.get_curve_coefficients()
      • DefDoseRates.get_attribute_value()
  • 4.1.1.5.3. bca_tool_code.operation_input_modules.orvr_fuelchanges module
    • OrvrFuelChanges
      • OrvrFuelChanges.__init__()
      • OrvrFuelChanges.init_from_file()
      • OrvrFuelChanges.get_ml_per_gram()
  • 4.1.1.5.4. bca_tool_code.operation_input_modules.repair_and_maintenance module
    • RepairAndMaintenance
      • RepairAndMaintenance.__init__()
      • RepairAndMaintenance.init_from_file()
      • RepairAndMaintenance.get_attribute_value()
  • 4.1.1.5.5. bca_tool_code.operation_input_modules.repair_calc_attribute module
    • RepairCalcAttribute
      • RepairCalcAttribute.__init__()
      • RepairCalcAttribute.init_from_file()
      • RepairCalcAttribute.get_attribute_value()
• 4.1.1.6. bca_tool_code.operation_modules package
  • 4.1.1.6.1. Submodules
  • 4.1.1.6.2. bca_tool_code.operation_modules.def_cost module
    • calc_def_doserate()
    • calc_def_cost()
  • 4.1.1.6.3. bca_tool_code.operation_modules.fuel_cost module
    • calc_fuel_cost()
  • 4.1.1.6.4. bca_tool_code.operation_modules.repair_cost module
    • EmissionRepairCost
      • EmissionRepairCost.__init__()
      • EmissionRepairCost.calc_repair_cost()

4.1.2. Submodules

4.1.3. bca_tool_code.cost_calcs module

class CostCalcs

Bases: object

__init__()

calc_results(settings)

update_object_dict(key, update_dict)

Parameters:

• key – tuple; (vehicle_id, option_id, modelyear_id, age_id, discount_rate).

• update_dict – Dictionary; represents the attribute-value pairs to be updated.

Returns:

Updates the object dictionary with each attribute updated with the appropriate value.

get_attribute_values(key, *attribute_names)

Parameters:

• key – tuple; (vehicle_id, option_id, model_year, age_id, discount_rate).

• attribute_names – str(s); the attribute names for which values are sought.

Returns:

A list of attribute values associated with attribute_names for the given key.

get_attribute_value(key, attribute_name)

Parameters:

• key – tuple; (vehicle_id, option_id, model_year, age_id, discount_rate).

• attribute_name – str; the attribute name for which a value is sought.

Returns:

The attribute value associated with attribute_name for the given key.

static create_new_attributes(settings)

Parameters:

settings – object; the SetInputs class object.

Returns:

A list of new attributes to be added to the data_object dictionary.

add_keys_for_discounting(general_inputs, input_dict)

Parameters:

• general_inputs – object; the GeneralInputs class object.

• input_dict – Dictionary; into which new keys will be added that provide room for discounting data.

Returns:

The passed dictionary with new keys added.

4.1.4. bca_tool_code.set_inputs module

class SetInputs

Bases: object

The SetInputs class establishes the input files to use and other input settings set in the BCA_Inputs file and needed within the tool.

__init__()

4.1.5. bca_tool_code.set_paths module

class SetPaths

Bases: object

The SetPaths class sets the paths and run_id info used by the tool.

__init__()

files_in_code_folder()

This is just a generator that allows for copy/paste of tool code into a bundle of folders and files saved to the outputs folder.

Returns:

A generator object.

copy_code_to_destination(destination)

This is just a generator that allows for copy/paste of tool code into a bundle of folders and files saved to the outputs folder.

Parameters:

destination – Path; the destination folder; destination folder must exist prior to method call.

Returns:

Nothing, but copies contents of code folder to the destination.

static run_id()

This method allows for a user-interactive identifier (name) for the given run.

Returns:

A console prompt to enter a run identifier; entering “test” sends outputs to a test folder; if left blank a default name is used.

create_output_paths(start_time_readable, run_id)

Parameters::

start_time_readable: str; the start time of the run, in text readable format.

run_id: str; the run ID entered by the user or the default value if the user does not provide an ID.

Returns:

Output paths into which to save outputs of the given run.

4.1.6. bca_tool_code.tool_main module

main()

This is the main module of the tool.

Returns:

The results of the current run of the tool.