h2integrate.simulation.technologies.iron.iron

Functions

run_iron_cost_model(config)	Calculates the capital expenditure (CapEx) and operating expenditure (OpEx) for a iron manufacturing plant based on the provided configuration.
run_iron_finance_model(config)	Executes the financial model for iron production, calculating the breakeven price of iron and other financial metrics based on the provided configuration and cost models.
run_iron_full_model(h2integrate_config)	Runs the full iron model, including capacity (performance), cost, and finance models.
run_size_iron_plant_performance(config)	Calculates either the annual iron production in metric tons based on plant capacity and available hydrogen or the amount of required hydrogen based on a desired iron production.

Classes

IronCostModelConfig(performance[, ...])	Configuration inputs for the iron cost model.
IronCostModelOutputs([costs_df])	Outputs from the iron cost model.
IronFinanceModelConfig(cost, performance[, ...])	Configuration inputs for the iron finance model.
IronFinanceModelOutputs(sol, summary, ...)	Represents the outputs of the iron finance model, encapsulating the results of financial analysis for iron production.
IronPerformanceModelConfig([...])	Configuration inputs for the iron performance model.
IronPerformanceModelOutputs([performances_df])	Outputs from the iron performance model.

class h2integrate.simulation.technologies.iron.iron.IronPerformanceModelConfig(product_selection='', site=Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<class 'dict'>, init=True, repr=True, hash=None, compare=True, metadata=mappingproxy({}), kw_only=<dataclasses._MISSING_TYPE object>, _field_type=None), model=Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<class 'dict'>, init=True, repr=True, hash=None, compare=True, metadata=mappingproxy({}), kw_only=<dataclasses._MISSING_TYPE object>, _field_type=None), params=Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<class 'dict'>, init=True, repr=True, hash=None, compare=True, metadata=mappingproxy({}), kw_only=<dataclasses._MISSING_TYPE object>, _field_type=None))

Configuration inputs for the iron performance model.

Parameters:

• product_selection (str)

• site (dict)

• model (dict)

• params (dict)

product_selection

The particular iron product selected.

Type:

str

site

Contains information on the site where iron is being reduced.

Type:

dict

model

Contains name of performance model and, if necessary, filepaths to secure location passed from input if not part of public H2Integrate. Also contains 'refit_coeffs' boolean to re-do model coefficient curve fitting.

Type:

dict

params

The rest of the parameters for the performance model.

Type:

dict

product_selection: str

site: dict

model: dict

params: dict

class h2integrate.simulation.technologies.iron.iron.IronPerformanceModelOutputs(performances_df=Empty DataFrame Columns: [] Index: [])

Outputs from the iron performance model.

Parameters:

performances_df (DataFrame)

performances_df

Contains locations and modeled iron plant performance outputs.

Type:

DataFrame

performances_df: DataFrame

h2integrate.simulation.technologies.iron.iron.run_size_iron_plant_performance(config)

Calculates either the annual iron production in metric tons based on plant capacity and available hydrogen or the amount of required hydrogen based on a desired iron production.

Parameters:

config (IronPerformanceModelConfig) -- Configuration object containing all necessary parameters for the capacity sizing, including capacity factor estimate and feedstock costs.

Returns:

IronPerformanceModelOutputs -- An object containing iron plant capacity in metric tons per year and amount of hydrogen required in kilograms per year.

Return type:

IronPerformanceModelOutputs

class h2integrate.simulation.technologies.iron.iron.IronCostModelConfig(performance, product_selection='', site=Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<class 'dict'>, init=True, repr=True, hash=None, compare=True, metadata=mappingproxy({}), kw_only=<dataclasses._MISSING_TYPE object>, _field_type=None), model=Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<class 'dict'>, init=True, repr=True, hash=None, compare=True, metadata=mappingproxy({}), kw_only=<dataclasses._MISSING_TYPE object>, _field_type=None), params=Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<class 'dict'>, init=True, repr=True, hash=None, compare=True, metadata=mappingproxy({}), kw_only=<dataclasses._MISSING_TYPE object>, _field_type=None))

Configuration inputs for the iron cost model.

Parameters:

• performance (IronPerformanceModelOutputs)

• product_selection (str)

• site (dict)

• model (dict)

• params (dict)

performance

Outputs from the performance model.

Type:

IronPerformanceModelOutputs

product_selection

The particular iron product selected.

Type:

str

site

Contains information on the site where iron is being reduced.

Type:

dict

model

Contains name of cost model and, if necessary, filepaths to secure location passed from input if not part of public H2Integrate. Also contains 'refit_coeffs' boolean to re-do model coefficient curve fitting.

Type:

dict

params

The rest of the parameters for the cost model.

Type:

dict

performance: IronPerformanceModelOutputs

product_selection: str

site: dict

model: dict

params: dict

class h2integrate.simulation.technologies.iron.iron.IronCostModelOutputs(costs_df=Empty DataFrame Columns: [] Index: [])

Outputs from the iron cost model.

Parameters:

costs_df (DataFrame)

costs_df

Contains locations and modeled iron plant cost outputs.

Type:

DataFrame

costs_df: DataFrame

h2integrate.simulation.technologies.iron.iron.run_iron_cost_model(config)

Calculates the capital expenditure (CapEx) and operating expenditure (OpEx) for a iron manufacturing plant based on the provided configuration.

Parameters:

config (IronCostModelConfig) -- Configuration object containing all necessary parameters for the cost model, including plant capacity, feedstock costs, and integration options for oxygen and heat.

Returns:

IronCostModelOutputs -- An object containing detailed breakdowns of capital and operating costs, as well as total plant cost and other financial metrics.

Return type:

IronCostModelOutputs

Note

The calculation includes various cost components such as electric arc furnace (EAF) casting, shaft furnace, oxygen supply, hydrogen preheating, cooling tower, and more, adjusted based on the Chemical Engineering Plant Cost Index (CEPCI).

class h2integrate.simulation.technologies.iron.iron.IronFinanceModelConfig(cost, performance, product_selection='', site=Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<class 'dict'>, init=True, repr=True, hash=None, compare=True, metadata=mappingproxy({}), kw_only=<dataclasses._MISSING_TYPE object>, _field_type=None), model=Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<class 'dict'>, init=True, repr=True, hash=None, compare=True, metadata=mappingproxy({}), kw_only=<dataclasses._MISSING_TYPE object>, _field_type=None), params=Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<class 'dict'>, init=True, repr=True, hash=None, compare=True, metadata=mappingproxy({}), kw_only=<dataclasses._MISSING_TYPE object>, _field_type=None), pf=Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<dataclasses._MISSING_TYPE object>, init=False, repr=True, hash=None, compare=True, metadata=mappingproxy({}), kw_only=<dataclasses._MISSING_TYPE object>, _field_type=None))

Configuration inputs for the iron finance model.

Parameters:

• cost (IronCostModelOutputs)

• performance (IronPerformanceModelOutputs)

• product_selection (str)

• site (dict)

• model (dict)

• params (dict)

• pf (dict | None)

cost

Outputs from the cost model.

Type:

IronCostModelOutputs

performance

Outputs from the performance model.

Type:

IronPerformanceModelOutputs

product_selection

The particular iron product selected.

Type:

str

site

Contains information on the site where iron is being reduced.

Type:

dict

model

Contains name of finance model and, if necessary, filepaths to secure location passed from input if not part of public H2Integrate. Also contains 'refit_coeffs' boolean to re-do model coefficient curve fitting.

Type:

dict

params

The rest of the parameters for the finance model.

Type:

dict

pf

Optional dictionary of the ProFAST object.

Type:

dict

cost: IronCostModelOutputs

performance: IronPerformanceModelOutputs

product_selection: str

site: dict

model: dict

params: dict

pf: dict | None

class h2integrate.simulation.technologies.iron.iron.IronFinanceModelOutputs(sol, summary, price_breakdown, pf)

Represents the outputs of the iron finance model, encapsulating the results of financial analysis for iron production.

Parameters:

• sol (dict)

• summary (dict)

• price_breakdown (DataFrame)

• pf (object)

sol

A dictionary containing the solution to the financial model, including key financial indicators such as NPV (Net Present Value), IRR (Internal Rate of Return), and breakeven price.

Type:

dict

summary

A summary of key results from the financial analysis, providing a high-level overview of financial metrics and performance indicators.

Type:

dict

price_breakdown

A Pandas DataFrame detailing the cost breakdown for producing iron, including both capital and operating expenses, as well as the impact of various cost factors on the overall price of iron.

Type:

pd.DataFrame

pf

ProFAST object.

Type:

object

sol: dict

summary: dict

price_breakdown: DataFrame

pf: object

h2integrate.simulation.technologies.iron.iron.run_iron_finance_model(config)

Executes the financial model for iron production, calculating the breakeven price of iron and other financial metrics based on the provided configuration and cost models.

This function integrates various cost components, including capital expenditures (CapEx), operating expenses (OpEx), and owner's costs. It leverages the ProFAST financial analysis software framework.

Parameters:

config (IronFinanceModelConfig) -- Configuration object containing all necessary parameters and assumptions for the financial model, including plant characteristics, cost inputs, financial assumptions, and grid prices.

Returns:

IronFinanceModelOutputs -- Object containing detailed financial analysis results, including solution metrics, summary values, price breakdown, iron price breakdown per tonne, and the ProFAST object. This output is instrumental in assessing the financial performance and breakeven price for the iron production facility.

Return type:

IronFinanceModelOutputs

h2integrate.simulation.technologies.iron.iron.run_iron_full_model(h2integrate_config)

Runs the full iron model, including capacity (performance), cost, and finance models.

Parameters:

h2integrate_config (dict) -- The configuration for the h2integrate model.

Returns:

Tuple[IronPerformanceModelOutputs, IronCostModelOutputs, IronFinanceModelOutputs] -- A tuple containing the outputs of the iron capacity, cost, and finance models.

Return type:

tuple[IronPerformanceModelOutputs, IronCostModelOutputs, IronFinanceModelOutputs]