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

INPUT FILE FORMAT

The file format consists of a one-row data header and subsequent data rows.

The data represent the linear relationship used to estimate DEF dose rates using the equation doserate = ((nox_std - nox_engine_out) - intercept) / slope

File Type

comma-separated values (CSV)

Sample Data Columns

regClassID	fuelTypeID	engineout_NOx	standard_NOx	slope_DEFdoserate	intercept_DEFdoserate
41	2	4	0.2	-73.679	0.0149
42	2	4	0.2	-73.679	0.0149
46	2	4	0.2	-73.679	0.0149
47	2	4	0.2	-73.679	0.0149
48	2	4	0.2	-73.679	0.0149

Data Column Name and Description

regClassID:

The MOVES regClass ID, an integer.

fuelTypeID:

The MOVES fuel type ID, an integer, where 1=Gasoline, 2=Diesel, etc.

engineout_NOx:

The estimated engine-out NOx emissions in grams per brake horsepower hour.

standard_NOx:

The tailpipe standard NOx emissions in grams per brake horsepower hour.

slope_DEFdoserate:

The slope of the DEF doserate linear relationship.

intercept_DEFdoserate:

The intercept of the DEF doserate linear relationship.

---

CODE

class DefDoseRates

Bases: object

The DefDoseRates class reads the DEF dose rates file and provides methods to query its contents.

__init__()

init_from_file(filepath)

Parameters:

filepath – Path to the specified file.

Returns:

Reads file at filepath; converts monetized values to analysis dollars (if applicable); creates a dictionary and other attributes specified in the class __init__.

get_curve_coefficients(engine)

Parameters:

engine – tuple; (regclass_id, fueltype_id).

Returns:

The slope and intercept curve coefficients for calculating DEF doserate.

get_attribute_value(engine, attribute_name)

Parameters:

• engine – tuple; (regclass_id, fueltype_id).

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

Returns:

The slope or intercept curve coefficient for calculating DEF doserate.

4.1.1.5.3. bca_tool_code.operation_input_modules.orvr_fuelchanges module

INPUT FILE FORMAT

The file format consists of a one-row data header and subsequent data rows.

The data represent the milliliters of gasoline available to burn for work for every gram of hydrocarbon captured.

File Type

comma-separated values (CSV)

Sample Data Columns

optionID	regClassID	fuelTypeID	ml/g
0	41	1	0
0	42	1	0
0	46	1	0
0	47	1	0
0	48	1	0
1	41	1	0
1	42	1	1.48
1	46	1	1.48
1	47	1	1.48
1	48	1	1.48

Data Column Name and Description

optionID:

The option or alternative number.

regClassID:

The MOVES regClass ID, an integer.

fuelTypeID:

The MOVES fuel type ID, an integer, where 1=Gasoline, 2=Diesel, etc.

ml/g:

The milliliters of gasoline per gram of hydrocarbon.

---

CODE

class OrvrFuelChanges

Bases: object

The OrvrFuelChanges class reads the orvr_fuelchanges_cap file and provides methods to query its contents.

__init__()

init_from_file(filepath)

Parameters:

filepath – Path to the specified file.

Returns:

Reads file at filepath; converts monetized values to analysis dollars (if applicable); creates a dictionary and other attributes specified in the class __init__.

get_ml_per_gram(engine, alt)

Parameters:

• engine – tuple; (regclass_id, fueltype_id).

• alt – int; the option_id.

Returns:

The milliliters of gasoline per gram of hydrocarbon captured that is available to be burned in the engine.

4.1.1.5.4. bca_tool_code.operation_input_modules.repair_and_maintenance module

INPUT FILE FORMAT

The file format consists of a one-row data header and subsequent data rows.

The data represent the repair and maintenance cost per mile/hour values, their dollar basis and other metrics used to estimate emission-related repair costs.

File Type

comma-separated values (CSV)

Sample Data Columns

Metric	Units	Value	DollarBasis	Notes
repair_and_maintenance	dollars_per_mile	0.158	2017
repair_and_maintenance	dollars_per_hour	6.31	2017
typical_vmt_thru	age_id	6		ageID=6 would include 7 years
emission_repair_share	share_of_total_repair_and_maintenance	0.108

Data Column Name and Description

Metric:

The name of the given attribute.

Units:

The units of the given attribute value.

Value:

The value of the given metric.

DollarBasis:

The dollar basis (dollars valued in what year) for the corresponding cost; costs are converted to analysis dollars in-code.

---

CODE

class RepairAndMaintenance

Bases: object

The RepairAndMaintenance class reads the repair and maintenance input file, converts monetized values to analysis dollars, and provides methods to query its contents.

__init__()

init_from_file(filepath, general_inputs, deflators)

Parameters:

• filepath – Path to the specified file.

• general_inputs – The GeneralInputs class object.

• deflators – The Deflators class object.

Returns:

Reads file at filepath; converts monetized values to analysis dollars (if applicable); creates a dictionary and other attributes specified in the class __init__.

get_attribute_value(key)

Parameters:

key – tuple of strings; e.g., (‘repair_and_maintenance’, ‘dollars_per_mile’).

Returns:

The value of the passed attribute.

4.1.1.5.5. bca_tool_code.operation_input_modules.repair_calc_attribute module

INPUT FILE FORMAT

The file format consists of a one-row data header and subsequent data rows.

The data represent the repair and maintenance cost attribute (i.e., cost per mile/hour) to use in estimating emission-related repair costs.

File Type

comma-separated values (CSV)

Sample Data Columns

sourceTypeID	attribute
31	dollars_per_mile
32	dollars_per_mile
41	dollars_per_hour
42	dollars_per_hour
43	dollars_per_hour
51	dollars_per_hour
52	dollars_per_hour
53	dollars_per_mile
54	dollars_per_mile
61	dollars_per_mile
62	dollars_per_mile

Data Column Name and Description

sourceTypeID:

The MOVES sourcetype ID, an integer.

attribute:

The attribute to use for the given sourcetype ID.

---

CODE

class RepairCalcAttribute

Bases: object

The RepairCalcAttribute class reads the repair calculation attribute input file, and provides methods to query its contents.

__init__()

init_from_file(filepath)

Parameters:

filepath – Path to the specified file.

Returns:

Reads file at filepath; converts monetized values to analysis dollars (if applicable); creates a dictionary and other attributes specified in the class __init__.

get_attribute_value(sourcetype_id)

Parameters:

sourcetype_id – int; the vehicle sourcetype_id.

Returns:

The repair calculation attribute (dollars_per_mile or dollars_per_hour) to use when calculating emission-related repair costs.