omegalpes.economy package

Submodules

omegalpes.economy.costs module

omegalpes.economy.economy module

class omegalpes.economy.economy.EconomicObject(time, name, **units)

Bases: OptObject

add_cashflow(time, name, description, cashflow_value, **units)

Add a cashflow (cost, income or transaction) to the unit

Parameters

• cashflow_value: float: value of the cash flow to consider

add_cost_to_costs_exp(unit, cost_name)

add_cost_to_operation_and_maintenance_exp(unit, cost_name)

add_income_to_incomes_exp(unit, income_name)

add_quantity_dependant_cashflow(time, name, description, value, quantity_name, quantity_unit, **units)

add_rate_cashflow(time, name, description, rate_value, cashflow_value, **units)

Add a cashflow (cost, income or transaction), based on another cashflow value, to the unit

Parameters

• rate_value

• cashflow_value: float: value of the cash flow to consider

add_spread_cashflow(time, name, description, cashflow_value, spread_duration, **units)

Description

Spread CashFlow class to enable to spread a cashflow over a duration

or over the whole time study (income, transaction or cost)

Parameters

• investment_value: float: value of the investment to consider

• spread_duration: int: duration over which the investment will be

spread, the whole duration of the study is considered by definition

calc_costs(unit)

calc_incomes(unit)

calc_operation_and_maintenance_costs(unit)

class omegalpes.economy.economy.EnergyUnitCostsIncomes(*, time, energy_unit, energy_cost: int = None, operation_starting_cost: int = None, operation_switch_off_cost: int = None, operation_fixed_cost: int = None, maintenance_fixed_cost: int = None, maintenance_investment_rate_cost: int = None, investment_cost: int = None, investment_spread_duration: int = None, energy_incomes=None, grant_incomes=None, grant_spread_duration=None)

Bases: EconomicObject

Class to define the costs and the incomes associated to an energy unit

Parameters :param time: time of the model :param energy_unit: energy unit on which the costs and incomes will be

added

:param investment_value : value of the investment :param investment_spread_duration : duration on which the investment

is spread

class omegalpes.economy.economy.EnergyUnitTransaction(time, name, beneficiary, payer, fixed_cashflow=None, spread_cashflow_duration=None, energy_price=None, energy_unit=None)

Bases: Transaction, EnergyUnitCosts, EnergyUnitIncomes

Description

A transaction based on a subscription and on the price of the good at each step

Parameters

class omegalpes.economy.economy.Transaction(time, name, beneficiary, payer, fixed_cashflow, spread_cashflow_duration, energy_price, energy_unit)

Bases: EconomicObject

omegalpes.economy.incomes module

class omegalpes.economy.incomes.EnergyUnitIncomes(time, name, energy_unit, energy_incomes=None, grant_value=None, grant_spread_duration=None)

Bases: Incomes

add_energy_incomes(time, name, energy_incomes, energy_unit)

Add an incomes linked to the energy produced or consumed by the energy unit

add_grant(time, name, grant_value, energy_unit)

Add grant to the energy unit

Parameters

• grant_value: int or float: value of the investment to consider

add_spread_grant(time, name, grant_value, spread_duration, energy_unit)

Add spead grant

Parameters

• investment_value: float: value of the investment to consider

• spread_duration: int: duration over which the investment will be

spread, the whole duration of the study is considered by definition

class omegalpes.economy.incomes.Incomes(time, name, unit)

Bases: EconomicObject

omegalpes.economy.tariffs module

class omegalpes.economy.tariffs.TURPE5(time, subscribed_power=[0, 0, 0, 0, 0], voltage_level='HTB2', use='CU', peak='fixed')

Bases: Tariff

class omegalpes.economy.tariffs.Tariff(name)

Bases: OptObject

Module contents