aixweather package

AixWeather-Module. See readme or documentation for more information.

Subpackages

• aixweather.core_data_format_2_output_file package
  • Submodules
  • aixweather.core_data_format_2_output_file.to_epw_energyplus module
    • fill_full_first_day()
    • fill_full_last_day()
    • to_epw()
  • aixweather.core_data_format_2_output_file.to_mos_TMY3 module
    • ModelicaTMY3Format
      • ModelicaTMY3Format.export_format()
    • to_mos()
  • aixweather.core_data_format_2_output_file.unconverted_to_x module
    • to_csv()
    • to_json()
    • to_pickle()
• aixweather.imports package
  • Submodules
  • aixweather.imports.DWD module
    • import_DWD_forecast()
    • import_DWD_historical()
    • import_meta_DWD_forecast()
    • import_meta_DWD_historical()
  • aixweather.imports.EPW module
    • load_epw_from_file()
    • load_epw_meta_from_file()
  • aixweather.imports.ERC module
    • import_ERC()
    • import_meta_from_ERC()
    • load_credentials_ERC_weather_data()
  • aixweather.imports.TRY module
    • get_city_from_location()
    • load_try_from_file()
    • load_try_meta_from_file()
  • aixweather.imports.custom_file module
    • load_custom_from_file()
    • load_custom_meta_data()
  • aixweather.imports.utils_import module
    • MetaData
      • MetaData.altitude
      • MetaData.latitude
      • MetaData.longitude
      • MetaData.set_imported_timezone()
      • MetaData.station_name
      • MetaData.timezone
• aixweather.transformation_functions package
  • Submodules
  • aixweather.transformation_functions.auxiliary module
    • evaluate_transformations()
    • fill_nan_from_format_dict()
    • force_data_variable_convention()
    • rename_columns()
    • replace_dummy_with_nan()
    • select_entry_by_core_name()
  • aixweather.transformation_functions.pass_through_handling module
    • create_pass_through_variables()
    • pass_through_measurements_with_back_and_forth_interpolating()
  • aixweather.transformation_functions.time_observation_transformations module
    • avg_following_hour_2_indicated_time()
    • avg_preceding_hour_2_indicated_time()
    • indicated_time_2_avg_following_hour()
    • indicated_time_2_avg_preceding_hour()
    • shift_time_by_dict()
    • shift_timestamps_and_interpolate()
    • truncate_data_from_start_to_stop()
  • aixweather.transformation_functions.unit_conversions module
    • Jcm2_to_Whm2()
    • Jm2_to_Whm2()
    • divide_by_1000()
    • eigth_to_tenth()
    • hPa_to_Pa()
    • kJm2_to_Whm2()
    • kelvin_to_celcius()
    • percent_to_tenth()
  • aixweather.transformation_functions.variable_transformations module
    • approximate_opaque_from_total_skycover()
    • calculate_dew_point_temp()
    • calculate_direct_horizontal_radiation()
    • calculate_global_horizontal_radiation()
    • calculate_horizontal_infrared_radiation()
    • calculate_normal_from_horizontal_direct_radiation()
    • robust_transformation()
    • variable_transform_all()
• aixweather.transformation_to_core_data package
  • Submodules
  • aixweather.transformation_to_core_data.DWD module
    • DWDForecast
      • DWDForecast.import_format()
    • DWDHistoricalFormat
      • DWDHistoricalFormat.import_format()
    • DWD_forecast_2_core_data()
    • DWD_historical_to_core_data()
  • aixweather.transformation_to_core_data.EPW module
    • EPWFormat
      • EPWFormat.export_format()
      • EPWFormat.import_format()
    • EPW_to_core_data()
  • aixweather.transformation_to_core_data.ERC module
    • ERCFormat
      • ERCFormat.import_format()
    • ERC_to_core_data()
  • aixweather.transformation_to_core_data.TRY module
    • TRYFormat
      • TRYFormat.import_format()
    • TRY_to_core_data()
  • aixweather.transformation_to_core_data.custom_file module
    • custom_to_core_data()

Submodules

aixweather.data_quality_checks module

This module includes functions for analyzing and visualizing missing values.

aixweather.data_quality_checks.plot_heatmap_missing_values(df)

Generate a heatmap to visualize missing values in a DataFrame.

Args:

df (pd.DataFrame): The DataFrame to be analyzed for missing values.

Returns:

plt: A Matplotlib figure representing the heatmap of missing values.

aixweather.data_quality_checks.print_df_info(df)

prints df info for intermediate checks or debugging

aixweather.definitions module

This module includes variables or functions which define central variables for the whole project.

class aixweather.definitions.CoreDataFormat

Bases: object

Information on core data: Time of measurement is always at the indicated time. Units as in TMY3 https://www.nrel.gov/docs/fy08osti/43156.pdf Only exception to TMY3 format is pressure, as all TMY3 data file actually use “Pa” instead of mbar

format: dict = {'Aerosol': {'unit': '1thousandth'}, 'AtmPressure': {'unit': 'Pa'}, 'CeilingH': {'unit': 'm'}, 'DewPointTemp': {'unit': 'degC'}, 'DiffHorRad': {'unit': 'Wh/m2'}, 'DiffuseHorIll': {'unit': 'lux'}, 'DirHorRad': {'unit': 'Wh/m2'}, 'DirNormRad': {'unit': 'Wh/m2'}, 'DirecNormIll': {'unit': 'lux'}, 'DryBulbTemp': {'unit': 'degC'}, 'ExtDirNormRad': {'unit': 'Wh/m2'}, 'ExtHorRad': {'unit': 'Wh/m2'}, 'GlobHorIll': {'unit': 'lux'}, 'GlobHorRad': {'unit': 'Wh/m2'}, 'HorInfra': {'unit': 'Wh/m2'}, 'LiquidPrecD': {'unit': 'mm/h'}, 'OpaqueSkyCover': {'unit': '1tenth'}, 'PrecWater': {'unit': 'mm'}, 'RelHum': {'unit': 'percent'}, 'Soil_Temperature_10cm': {'unit': 'degC'}, 'Soil_Temperature_1m': {'unit': 'degC'}, 'Soil_Temperature_20cm': {'unit': 'degC'}, 'Soil_Temperature_50cm': {'unit': 'degC'}, 'Soil_Temperature_5cm': {'unit': 'degC'}, 'TotalSkyCover': {'unit': '1tenth'}, 'Visibility': {'unit': 'km'}, 'WindDir': {'unit': 'deg'}, 'WindSpeed': {'unit': 'm/s'}, 'ZenithLum': {'unit': 'Cd/m2'}}

aixweather.definitions.result_folder_path() → str

Creates the path to the resultsfolder.

aixweather.definitions.results_file_path(filename: str, folder_path: str = None) → str

create a path to a results file

Args:

filename: name of file folder_path: path to result folder

Returns:

str: path to result file

aixweather.project_class module

This module contains the central project classes which are used by the user.

class aixweather.project_class.ProjectClassCustom(path, **kwargs)

Bases: ProjectClassGeneral

A class representing a project for importing and processing custom weather data. Modify this class and its functions to create your own weather data pipeline and consider to create a pull request to add the pipeline to the repository.

For common attributes, properties, and methods, refer to the base class.

Attributes:

path (str): The file path to the custom weather data.

data_2_core_data()

override abstract function

import_data()

override abstract function

class aixweather.project_class.ProjectClassDWDForecast(station: str, **kwargs)

Bases: ProjectClassGeneral

A class representing a project for importing and processing weather forecast data from DWD (Deutscher Wetterdienst).

For common attributes, properties, and methods, refer to the base class.

Attributes:

station (str): The identifier of the KML grid associated with the forecast data.

data_2_core_data()

override abstract function

import_data()

override abstract function

class aixweather.project_class.ProjectClassDWDHistorical(start: datetime, end: datetime, station: str, **kwargs)

Bases: ProjectClassGeneral

A class representing a project for importing and processing historical weather data from DWD (Deutscher Wetterdienst).

For common attributes, properties, and methods, refer to the base class.

Attributes:

station (str): The identifier of the DWD weather station associated with the data.

data_2_core_data()

override abstract function

import_data()

override abstract function

class aixweather.project_class.ProjectClassEPW(path, **kwargs)

Bases: ProjectClassGeneral

A class representing a project for importing and processing weather data from EPW (EnergyPlus Weather) format.

For common attributes, properties, and methods, refer to the base class.

Attributes:

path (str): The absolute file path to the EPW weather data.

data_2_core_data()

override abstract function

import_data()

override abstract function

class aixweather.project_class.ProjectClassERC(start: datetime, end: datetime, cred: tuple = None, **kwargs)

Bases: ProjectClassGeneral

A class representing a project for importing and processing weather data from the ERC (Energy Research Center).

For common attributes, properties, and methods, refer to the base class.

Attributes:

cred (tuple): A tuple containing credentials or authentication information for accessing the data source.

data_2_core_data()

override abstract function

import_data()

override abstract function

class aixweather.project_class.ProjectClassGeneral(**kwargs)

Bases: ABC

An abstract base class representing a general project.

For each source of weather data, a project class should inherit from this class and implement specific methods for data import and transformation.

Attributes:

fillna (bool): A flag indicating whether NaN values should be filled

in the output formats.

abs_result_folder_path (str): Optionally define the absolute path to

the desired export location.

start (pd.Timestamp or None): The start date of the project data in UTC

(sometimes inferred by the inheriting class).

end (pd.Timestamp or None): The end date of the project data in UTC.

Properties:

imported_data (pd.DataFrame): The imported weather data. core_data (pd.DataFrame): The weather data in a standardized core

format.

output_df_<outputformat> (pd.DataFrame): The output data frame

(name depends on output format).

meta_data: Metadata associated with weather data origin.

Methods:

import_data(): An abstract method to import data from the specific

source.

data_2_core_data(): An abstract method to transform imported data into

core data format.

core_2_mos(): Convert core data to MOS format. core_2_epw(): Convert core data to EPW format. core_2_csv(): Convert core data to CSV format. core_2_json(): Convert core data to JSON format. core_2_pickle(): Convert core data to Pickle format.

core_2_csv(filename: str = None) → str

Convert core data to .csv file

filename (str): Name of the file to be saved. The default is constructed

based on the station name.

Returns:

str: Path to the exported file.

core_2_epw(filename: str = None, export_in_utc: bool = False) → str

Convert core data to .epw file

filename (str): Name of the file to be saved. The default is constructed

based on the meta-data as well as start and stop time

export_in_utc (bool): Timezone to be used for the export.

True (default) to use the core_df timezone, UTC+0, False (default) to use timezone from metadata

Returns:

str: Path to the exported file.

core_2_json(filename: str = None) → str

Convert core data to .json file

filename (str): Name of the file to be saved. The default is constructed

based on the station name.

Returns:

str: Path to the exported file.

core_2_mos(filename: str = None, export_in_utc: bool = False) → str

Convert core data to .mos file

filename (str): Name of the file to be saved. The default is constructed

based on the meta-data as well as start and stop time

export_in_utc (bool): Timezone to be used for the export.

True (default) to use the core_df timezone, UTC+0, False (default) to use timezone from metadata

Returns:

str: Path to the exported file.

core_2_pickle(filename: str = None) → str

Convert core data pickle file

filename (str): Name of the file to be saved. The default is constructed

based on the station name.

Returns:

str: Path to the exported file.

property core_data

Get core data

abstract data_2_core_data()

Abstract function to convert the imported data to core data.

abstract import_data()

Abstract function to import weather data.

property imported_data

Get imported data

start_end_checks()

Make sure start and end are of type datetime and end is after start.

class aixweather.project_class.ProjectClassTRY(path, **kwargs)

Bases: ProjectClassGeneral

A class representing a project for importing and processing weather data from TRY (Test Reference Year) format.

For common attributes, properties, and methods, refer to the base class.

Attributes:

path (str): The absolute file path to the TRY weather data.

data_2_core_data()

override abstract function

import_data()

override abstract function