src.system.projection.parameters.ProjectionParameters

class src.system.projection.parameters.ProjectionParameters(start_t: date, projection_length: relativedelta, time_step: relativedelta, resource_dir_path: str, output_dir_path: str, processing_type: ProcessingType, projection: str, data_source: str)

Container class for all Projection parameters. Additional projection parameters can be added here (for all projections), or this class can be inherited and extended for additional parameters.

Inheritance Diagram

Variables & Properties

start_t	Initial projection time step.
projection_length	Projection duration.
end_t	Ending projection time step.
time_step	Projection time step interval.
resource_dir_path	Resource directory path.
output_dir_path	Output directory path.
processing_type	Processing type.
projection	Projection import path.
data_source	Data source import path.

Methods

__init__(start_t, projection_length, ...)	Constructor method.
from_json(path)	Class factory that constructs an instance of this class by deserializing a JSON file.

Details

__init__(start_t: date, projection_length: relativedelta, time_step: relativedelta, resource_dir_path: str, output_dir_path: str, processing_type: ProcessingType, projection: str, data_source: str)

Constructor method. Initializes all variables in this class.

Parameters:

• start_t – Initial projection time step.

• projection_length – Projection duration.

• time_step – Projection time step interval.

• resource_dir_path – Resource directory path.

• output_dir_path – Output directory path.

• processing_type – Processing type.

• projection – Projection import path.

• data_source – Data source import path.

data_source: str

Data source import path.

end_t: date

Ending projection time step.

classmethod from_json(path: str) → Self

Class factory that constructs an instance of this class by deserializing a JSON file.

Parameters:

path – Input JSON file path.

Returns:

Instance of this class.

output_dir_path: str

Output directory path.

processing_type: ProcessingType

Processing type. Controls how the projection is run and distributed.

projection: str

Projection import path.

projection_length: relativedelta

Projection duration.

resource_dir_path: str

Resource directory path.

start_t: date

Initial projection time step.

time_step: relativedelta

Projection time step interval.