outdoor_environment

Modules

outdoor_environment_system module

class OutdoorEnvironmentSystem(df=None, useSpreadsheet=False, useDatabase=False, filename_outdoorTemperature=None, datecolumn_outdoorTemperature=0, valuecolumn_outdoorTemperature=1, filename_globalIrradiation=None, datecolumn_globalIrradiation=0, valuecolumn_globalIrradiation=1, filename_outdoorCo2Concentration=None, datecolumn_outdoorCo2Concentration=0, valuecolumn_outdoorCo2Concentration=1, uuid_outdoorTemperature=None, name_outdoorTemperature=None, dbconfig_outdoorTemperature=None, uuid_globalIrradiation=None, name_globalIrradiation=None, dbconfig_globalIrradiation=None, uuid_outdoorCo2Concentration=None, name_outdoorCo2Concentration=None, dbconfig_outdoorCo2Concentration=None, a=1, b=0, apply_correction=False, **kwargs)[source]

Bases: System, Module

An outdoor environment system model that provides weather data for building simulations.

This model represents the outdoor environment by providing time-series data for: - Outdoor air temperature - Global solar irradiation - Outdoor CO2 concentration

The model reads weather data from 3 separate CSV files (one for each parameter) and can optionally apply a linear correction to the temperature data. The model is designed to be used as a boundary condition for building energy simulations.

Parameters:

  • df (Optional[DataFrame]) – Input DataFrame containing weather data. Must have columns ‘outdoorTemperature’, ‘globalIrradiation’, and ‘outdoorCo2Concentration’.

  • useSpreadsheet (Optional[bool]) – Whether to use spreadsheet files for data loading.

  • useDatabase (Optional[bool]) – Whether to use database for data loading.

  • filename_outdoorTemperature (Optional[str]) – Path to CSV file containing outdoor temperature data.

  • datecolumn_outdoorTemperature (Optional[int]) – Name of the date column in temperature file.

  • valuecolumn_outdoorTemperature (Optional[int]) – Name of the temperature value column.

  • filename_globalIrradiation (Optional[str]) – Path to CSV file containing global irradiation data.

  • datecolumn_globalIrradiation (Optional[int]) – Name of the date column in irradiation file.

  • valuecolumn_globalIrradiation (Optional[int]) – Name of the irradiation value column.

  • filename_outdoorCo2Concentration (Optional[str]) – Path to CSV file containing CO2 concentration data.

  • datecolumn_outdoorCo2Concentration (Optional[int]) – Name of the date column in CO2 file.

  • valuecolumn_outdoorCo2Concentration (Optional[int]) – Name of the CO2 value column.

  • a (Optional[float]) – Correction factor for linear correction of temperature data.

  • b (Optional[float]) – Correction offset for linear correction of temperature data.

  • apply_correction (Optional[bool]) – Whether to apply linear correction to temperature data.

do_step(secondTime=None, dateTime=None, step_size=None, stepIndex=None)[source]

Perform one simulation step.

This method reads the current weather data and applies optional linear corrections to the temperature values. The irradiation and CO2 concentration values are passed through without modification.

Parameters:

  • secondTime (float, optional) – Current simulation time in seconds.

  • dateTime (datetime, optional) – Current simulation date and time.

  • step_size (float, optional) – Time step size in seconds.

  • stepIndex (int, optional) – Current simulation step index.

Return type:

None

initialize(start_time, end_time, step_size, simulator)[source]

Initialize the outdoor environment system.

This method performs the following initialization steps: 1. Validates and resolves the weather data file paths 2. Loads weather data from 3 separate files or DataFrame 3. Verifies required data columns are present

Parameters:

  • start_time (datetime.datetime) – Start time of the simulation period.

  • end_time (datetime.datetime) – End time of the simulation period.

  • step_size (int) – Time step size in seconds.

  • simulator (core.Simulator) – Simulation model object.

Raises:

ValueError – If the weather data files cannot be found or required columns are missing.

Return type:

None

validate(p)[source]

Validate the system configuration.

This method checks if the required data source (either DataFrame or filename parameters) is provided. If not, it issues a warning and marks the system as invalid for simulation, estimation, evaluation, and monitoring.

Parameters:

p (object) – Printer object for outputting validation messages.

Returns:

Three boolean values indicating validation status for:

  • Simulator

  • Estimator

  • Optimizer

Return type:

tuple

property config

Get the configuration parameters.

Returns:

Dictionary containing configuration parameters and file reading settings.

Return type:

dict

property input: dict

Get the input ports of the outdoor environment system.

Returns:

Dictionary containing input ports (empty for leaf systems)

Return type:

dict

property output: dict

Get the output ports of the outdoor environment system.

Returns:

Dictionary containing output ports:

  • ”outdoorTemperature”: Outdoor air temperature [°C]

  • ”globalIrradiation”: Global solar irradiation [W/m²]

  • ”outdoorCo2Concentration”: Outdoor CO2 concentration [ppm]

Return type:

dict

sp = [<twin4build.translator.translator.SignaturePattern object>]
get_signature_pattern()[source]