reVX.least_cost_xmission.config.xmission_config.XmissionConfig

class XmissionConfig(config=None)

Bases: dict

Load default tie lines configuration

Use default values for all parameters if None.

Parameters:

config (str | dict, optional) – Path to json file containing Xmission cost configuration values, or jsonified dict of cost configuration values, or dictionary of configuration values, or dictionary of paths to config jsons, if None use defaults in ‘./config.json’

Methods

capacity_to_kv(capacity)	Convert capacity class to line voltage
clear()
copy()
fromkeys([value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items()
keys()
kv_to_capacity(kv)	Convert line voltage to capacity class
new_sub_cost(region, tie_line_voltage)	Extract new substation costs in $ for given region and tie-line voltage rating
pop(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised
popitem()	Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
sub_upgrade_cost(region, tie_line_voltage)	Extract substation upgrade costs in $ for given region and tie-line voltage rating
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()
xformer_cost(feature_voltage, tie_line_voltage)	Extract transformer costs in $ for given region and tie-line voltage rating

clear() → None.  Remove all items from D.

copy() → a shallow copy of D

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

capacity_to_kv(capacity)

Convert capacity class to line voltage

Parameters:

capacity (int) – Capacity class in MW

Returns:

kv (int) – Tie-line voltage in kv

kv_to_capacity(kv)

Convert line voltage to capacity class

Parameters:

kv (in) – Tie-line voltage in kv

Returns:

capacity (int) – Capacity class in MW

sub_upgrade_cost(region, tie_line_voltage)

Extract substation upgrade costs in $ for given region and tie-line voltage rating

Parameters:

• region (int) – Region code, used to extract ISO

• tie_line_voltage (int | str) – Tie-line voltage class in kV

Returns:

int – Substation upgrade cost

new_sub_cost(region, tie_line_voltage)

Extract new substation costs in $ for given region and tie-line voltage rating

Parameters:

• region (int) – Region code, used to extract ISO

• tie_line_voltage (int | str) – Tie-line voltage class in kV

Returns:

int – New substation cost

xformer_cost(feature_voltage, tie_line_voltage)

Extract transformer costs in $ for given region and tie-line voltage rating

Parameters:

• feature_voltage (int) – Voltage of feature that tie-line is connecting to

• tie_line_voltage (int | str) – Tie-line voltage class in kV

Returns:

int – Transformer cost as $/MW