energy_analysis_toolbox.keywords module#

Contains the definition of “keywords”/ “magic values” used in library’s public API.

All variables in this module are basic python objects such as int, str, list etc.

Note about the naming conventions in this module#

In order to have readable yet as light as possible names, the following conventions are used in this module:

  1. Variables names are written in snake-case

  2. Names suffixed with “_f” are reserved for variables containing field names used to identify values in tables such as pandas dataframes

  3. Names suffixed with “_l” are reserved for sequences (lists) of keywords

Important

DO NOT use these keywords by typing directly their VALUES. The preferred use is to pass the variables defined in this module, so that:

  • your code will not be broken in case the content of the variable (the magic values) are modified

  • any misspelling will be caught by Python interpreter and lead to a NameError

  • you can benefit from the help of autocompletion tools provide by your IDE if you have one

Variables defined by the module#

The following reproduces the variables declarations from the module.

Usual timeseries field names#

energy_analysis_toolbox.keywords.start_f = 'start'#

The name of a field containing the beginning of a time-interval. Unless stated otherwise, the first instant to be included in the interval, as a timestamp.

energy_analysis_toolbox.keywords.end_f = 'end'#

The name of a field containing the end of a time-interval. Unless stated otherwise, the first instant to be excluded in the interval, as a timestamp.

energy_analysis_toolbox.keywords.time_f = 'timestamp'#

The name of the time-index in timeseries data.