h2integrate.converters.iron.iron_mine

h2integrate.converters.iron.iron_mine#

Classes

IronMineBaseConfig(*, mine, taconite_pellet_type)

IronMineCostComponent(**kwargs)

IronMineCostConfig(*, mine, taconite_pellet_type)

IronMinePerformanceComponent(**kwargs)

IronMinePerformanceConfig(*, mine, ...[, ...])

class h2integrate.converters.iron.iron_mine.IronMineBaseConfig(*, mine, taconite_pellet_type, model_name='martine_ore', model_fp='', inputs_fp='', coeffs_fp='', refit_coeffs=False)#
Parameters:

  • mine (str)

  • taconite_pellet_type (str)

  • model_name (str)

  • model_fp (str)

  • inputs_fp (str)

  • coeffs_fp (str)

  • refit_coeffs (bool)

mine: str#
taconite_pellet_type: str#
model_name: str#
model_fp: str#
inputs_fp: str#
coeffs_fp: str#
refit_coeffs: bool#
make_model_dict()#
make_site_dict()#
class h2integrate.converters.iron.iron_mine.IronMinePerformanceConfig(*, mine, taconite_pellet_type, model_name='martine_ore', model_fp='', inputs_fp='', coeffs_fp='', refit_coeffs=False, ore_cf_estimate=0.9)#
Parameters:

  • mine (str)

  • taconite_pellet_type (str)

  • model_name (str)

  • model_fp (str)

  • inputs_fp (str)

  • coeffs_fp (str)

  • refit_coeffs (bool)

  • ore_cf_estimate (float)

ore_cf_estimate: float#
make_model_dict()#
class h2integrate.converters.iron.iron_mine.IronMinePerformanceComponent(**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)#

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_mine.IronMineCostConfig(*, mine, taconite_pellet_type, model_name='martine_ore', model_fp='', inputs_fp='', coeffs_fp='', refit_coeffs=False, LCOE, LCOH, varom_model_name='martin_ore', operational_year, installation_years, plant_life, cost_year)#
Parameters:

  • mine (str)

  • taconite_pellet_type (str)

  • model_name (str)

  • model_fp (str)

  • inputs_fp (str)

  • coeffs_fp (str)

  • refit_coeffs (bool)

  • LCOE (float)

  • LCOH (float)

  • varom_model_name (str)

  • operational_year (int)

  • installation_years (int | float)

  • plant_life (int)

  • cost_year (int)

LCOE: float#
LCOH: float#
varom_model_name: str#
operational_year: int#
installation_years: int | float#
plant_life: int#
cost_year: int#
make_model_dict()#
make_cost_dict()#
class h2integrate.converters.iron.iron_mine.IronMineCostComponent(**kwargs)#
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