antupy.tsg.settings.TimeParams#

class antupy.tsg.settings.TimeParams(START: ~antupy.core.var.Var = 0 [hr], STOP: ~antupy.core.var.Var = 8760 [hr], STEP: ~antupy.core.var.Var = 60 [min], YEAR: ~antupy.core.var.Var = 1800 [-], engine: str = 'polars')[source]#

Time parameters for simulations. Useful for annual simulations, stochastic simulations, representative days simulations.

Parameters:

START (Var) – initial time of the simulation (in ‘hr’) (first hour of the year for annual simulation)
STOP (Var) – final time of the year (in ‘hr’).
STEP (Var) – timestep for the simulation (in ‘min’)
YEAR (Var) – Year of the simulation (useful only for annual simulations)
engine (str)

__init__(START: ~antupy.core.var.Var = 0 [hr], STOP: ~antupy.core.var.Var = 8760 [hr], STEP: ~antupy.core.var.Var = 60 [min], YEAR: ~antupy.core.var.Var = 1800 [-], engine: str = 'polars') → None#

Parameters:

START (Var)
STOP (Var)
STEP (Var)
YEAR (Var)
engine (str)

Return type:

None

Methods

__init__(START, STOP, STEP, YEAR, engine)

Attributes

`DAYS`	Based on START and STOP, returns the days of simulation.
`PERIODS`	Based on START, STOP and STEP, it returns the number of periods.
`START`
`STEP`
`STOP`
`YEAR`
`engine`
`idx`	It is the datetime series for the simulation (Polars or Pandas-based)
`idx_pd`	Pandas DatetimeIndex conversion of the simulation datetime series
`idx_pl`	It is the datetime series for the simulation (Polars-based)