API reference

energy_analysis_toolbox library is structured as follows. The main subpackages in ct are the following :

• energy_analysis_toolbox.timeseries is a subpackage containing generic functionalities related to time-series analysis, without assumption on the physical nature of the data.

• energy_analysis_toolbox.power and energy_analysis_toolbox.energy are subpackages containing functionalities related to power and energy computation, respectively, working directly on time-series.

• energy_analysis_toolbox.weather is a subpackage containing functionalities related to weather data, such as temperature and degree days.

• energy_analysis_toolbox.synthetic is a subpackage containing functionalities related to the generation of synthetic data.

The most commonly used of these functionalities can directly be accessed as pandas series/Dataframe methods such as:

my_power_series.eat.power_to_freq(...)

by importing the energy_analysis_toolbox.pandas extension module.

These packages are complemented by :

• energy_analysis_toolbox.constants containing constants used in the computations or useful in daily analysis of energy data.

• energy_analysis_toolbox.keywords containing keywords used in the lib interface (still to be improved).

• energy_analysis_toolbox.errors containing custom errors used in the lib.

Here is a detailed structure of the library :

• energy_analysis_toolbox.timeseries package
  • energy_analysis_toolbox.timeseries.create package
  • energy_analysis_toolbox.timeseries.extract_features package
  • energy_analysis_toolbox.timeseries.math package
  • energy_analysis_toolbox.timeseries.resample package
  • energy_analysis_toolbox.timeseries.profiles package
• energy_analysis_toolbox.power
  • energy_analysis_toolbox.power.basics
  • energy_analysis_toolbox.power.resample
  • energy_analysis_toolbox.power.overconsumption
• energy_analysis_toolbox.energy
  • energy_analysis_toolbox.energy.resample
• energy_analysis_toolbox.pandas
  • Series
  • EATAccessorDataFrame
  • EATAccessorSeries
• energy_analysis_toolbox.constants module
  • wh_to_j
  • kwh_to_j
• energy_analysis_toolbox.keywords module
  • Note about the naming conventions in this module
  • Variables defined by the module
  • Usual timeseries field names
• energy_analysis_toolbox.errors package
  • Base class for all custom errors
  • Errors related to timeseries consistency
  • Errors related to resampling
• energy_analysis_toolbox.tests package
  • Main module
  • Test suite
  • Fixtures
• energy_analysis_toolbox.synthetic
  • energy_analysis_toolbox.synthetic.thermosensitive_consumption
• energy_analysis_toolbox.weather
  • energy_analysis_toolbox.weather.degree_days
  • Main Features
• energy_analysis_toolbox.thermosensitivity package
  • Submodules
  • Module contents