Analysis Definition¶

Analysis Definition - Single

The analysis definition module is used for loading an already generated reduced order and running a subsequent analysis. The input is a JSON file that defines each of the covariates of interest. The analysis can take of

Single value analysis, see example
Sweep values over a year (as defined by an EPW file)
Sweep values over specified ranges

To run an analysis with a JSON file, first load a metamodel, then load the analysis defintion.

from rom.analysis_definition.analysis_definition import AnalysisDefinition
from rom.metamodels import Metamodels

Analysis Definition¶

Parser for analysis definition JSON files.

class rom.analysis_definition.analysis_definition.AnalysisDefinition(definition_file)[source]¶

Bases: object

Pass in a definition file and a weather file to generate distributions of models

as_dataframe()[source]¶

Return the dataframe with all the data needed to run the analysis defined in the json file.

Note that the first field in the analysis definition json file must be a value or an EPW.

Returns:	pandas dataframe

load_files(definition_file)[source]¶

load_weather_file(weather_file)[source]¶: Load in the weather file and convert the field names to what is expected in the JSON file :return:

EPW File¶

class rom.analysis_definition.epw_file.EpwFile(filepath)[source]¶

Bases: object

as_dataframe()[source]¶

Return the EPW file as a dataframe. This drops the data_source column for brevity.

Returns:	pandas DataFrame

post_process_data()[source]¶

Add in derived columns

Returns: