Economic Summary

summary

nrgise.economics.summary.EconomicSummary dataclass

EconomicSummary(
    parameters: dict,
    npv: float,
    static_amortisation_time: float,
    income_per_year: ndarray,
    cash_flow_per_year_differences: ndarray,
    maintenance_cost_per_year_differences: ndarray,
    replacement_cost_per_year_differences: ndarray,
    discounted_residual_value_difference: float,
)

A summary of the economic analysis, created by get_economic_summary().

The summary describes the economics the system, optionally compared against a baseline system. Fields ending in _differences represent the difference between the new system and baseline case.

nrgise.economics.summary.EconomicSummary.to_json

to_json(filename: str) -> None

dumps the EconomicSummary to a JSON file.

Parameters:

Name	Type	Description	Default
filename	str	The path to the file.	required

nrgise.economics.summary.get_economic_summary

get_economic_summary(
    initial_invest: float,
    cash_flow_per_year_new: ndarray,
    cash_flow_per_year_baseline: Optional[ndarray] = None,
    maintenance_cost_per_year_new: Optional[ndarray] = None,
    maintenance_cost_per_year_baseline: Optional[
        ndarray
    ] = None,
    replacement_cost_per_year_new: Optional[ndarray] = None,
    replacement_cost_per_year_baseline: Optional[
        ndarray
    ] = None,
    discounted_residual_value_new: float = 0.0,
    discounted_residual_value_baseline: float = 0.0,
    discount_rate: float = DEFAULT_DISCOUNT_RATE,
) -> EconomicSummary

Creates a EconomicSummary. Note that it can be used get the summary for a new system or for a comparison against a baseline system.

Parameters:

Name	Type	Description	Default
initial_invest	float	Upfront investment cost of the new case.	required
cash_flow_per_year_new	ndarray	Per year cash flow of the new case, excluding maintenance, replacement, and residual value.	required
cash_flow_per_year_baseline	Optional[ndarray]	Per year baseline cash flow. If None, zeros are assumed.	None
maintenance_cost_per_year_new	Optional[ndarray]	Per year maintenance cost of the new case. If None, zeros are assumed.	None
maintenance_cost_per_year_baseline	Optional[ndarray]	Per year baseline maintenance cost. If None, zeros are assumed.	None
replacement_cost_per_year_new	Optional[ndarray]	Per year replacement cost of the new case. If None, zeros are assumed.	None
replacement_cost_per_year_baseline	Optional[ndarray]	Per year baseline replacement cost. If None, zeros are assumed.	None
discounted_residual_value_new	float	Discounted residual value of the new case at the end of the horizon.	0.0
discounted_residual_value_baseline	float	Discounted residual value of the baseline case at the end of the horizon.	0.0
discount_rate	float	Yearly discount rate used.	DEFAULT_DISCOUNT_RATE

Returns:

Type	Description
EconomicSummary	EconomicSummary.