h2integrate.converters.iron.iron_transport

h2integrate.converters.iron.iron_transport#

Classes

IronTransportCostComponent(**kwargs)

IronTransportCostConfig(*, transport_year, ...)

IronTransportPerformanceComponent(**kwargs)

IronTransportPerformanceConfig(*, ...)

class h2integrate.converters.iron.iron_transport.IronTransportPerformanceConfig(*, find_closest_ship_site, shipment_site)#
Parameters:

  • find_closest_ship_site (bool)

  • shipment_site (str)

find_closest_ship_site: bool#
shipment_site: str#
class h2integrate.converters.iron.iron_transport.IronTransportPerformanceComponent(**kwargs)#
initialize()#

Perform any one-time initialization run at instantiation.

setup()#

Declare inputs and outputs.

Available attributes:

name pathname comm options

calculate_water_distance(waypoints, shipping_sites)#
calculate_land_distance(ship_site, starting_location, shipping_sites)#
compute(inputs, outputs)#

Compute outputs given inputs. The model is assumed to be in an unscaled state.

An inherited component may choose to either override this function or to define a compute_primal function.

Parameters:

  • inputs (Vector) -- Unscaled, dimensional input variables read via inputs[key].

  • outputs (Vector) -- Unscaled, dimensional output variables read via outputs[key].

  • discrete_inputs (dict-like or None) -- If not None, dict-like object containing discrete input values.

  • discrete_outputs (dict-like or None) -- If not None, dict-like object containing discrete output values.

class h2integrate.converters.iron.iron_transport.IronTransportCostConfig(*, transport_year, cost_year)#
Parameters:

  • transport_year (int)

  • cost_year (int)

transport_year: int#
cost_year: int#
class h2integrate.converters.iron.iron_transport.IronTransportCostComponent(**kwargs)#
initialize()#

Perform any one-time initialization run at instantiation.

setup()#

Declare inputs and outputs.

Available attributes:

name pathname comm options

compute(inputs, outputs, discrete_inputs, discrete_outputs)#

Computation for the OM component.

For a template class this is not implement and raises an error.

Contents