F R M e W O R K

Resources

General guidance and sample data to help you get started.

Help

Using the toolkit

The FRAMeWORK toolkit is completely data-driven. This means that all you need to do to run the functions is supply process-history data. Once you upload your data to the selected function, the function will automatically analyze your data and generate your results in the form of multiple types of visualizations and key performance indicators (KPI); these outputs will be preformatted in a report-style document. That's it!

A generic square placeholder image with rounded corners in a figure.
Figure 1: Data and analysis workflow flow.

Preparing and uploading data

The toolkit is comprised of seven discrete data-driven functions. Every functions serves a unique purpose in identifying operational deficiencies and thereof, requires different sets of data and generates unique sets of visualizations and key performance indicators (KPIs). To assist the user in invoking the functions, every function in the toolbar (left of the page) contains four sections - Overview, Input, Output, and Upload Data.

This section presents a brief overview of the function, including the motivation behind its conception, the kind of information you'd expect to get from it, and where applicable, how you can use this information to improve building energy efficiency.

This section presents the requisite input data type(s) for the function. Some functions require multiple data types to run while some might only need one. The required format for input (i.e., file type, arrangement , temporal resolution, number of files) and any restrictions subject to the data are also described here. If you'd like an example of how the data should look like, take a look at some of the sample data provided.

This section presents the visualizations and key performance indicators (KPIs) that the function generates, including how to interpret them, the kind of information they convey, and where applicable, how to address them through improved controls sequences. These outputs are automatically formatted and provided as report-style documents which also contain descriptions on how to interpret them.

If you're ready to use the functions, this section allows you to upload your data and invoke the functions. Upon successful data upload, the corresponding function will run automatically and analyze the data, and you will be provided with a link to download a report-style document containing the function's generated visualizations and KPIs once the analysis has concluded. Once the data has been analyzed, (regardless if successful or not), the data will be permanently deleted afterwards.

Once you've uploaded your data, you're half-way done! The function you've selected will automatically analyze your data and output the results once it has finished its analysis. The analysis may take some time, depending on the amount of data you inputted and the the function you selected. Functions that utilize a genetic algorithm (i.e., AHU anomaly detection, baseline energy performance, end-use disaggregation) will take a much longer time than other functions. Please be patient!

Retreiving results

Your results can be retrieved through a randomly generated link that is provided to you upon successful data upload. Retain this link as it is the only way you will be able to get your results. When you use the link, you may be presented with one of the three following prompts.

Your data are currently being processed or is still in line to be processed. Please be patient! Work on something else, go for walk, or try a cortado; we'll get to it soon! Refresh the page to check the status of the analysis.

The function has successfully analyzed your data and your results are ready to be downloaded. Select the "Download" button to begin downloading your results; a report-style document containing the generated visuals and KPIs should begin downloading.

Oops! An issue in the analysis prevented the function from completing its analysis. This is most commonly caused by incompatible or incorrectly formatted data. Ensure that your data do not contain non-numeric values (i.e., %,#,@,-,*, etc.) and that the data are formatted as prescribed in each function's respective Inputs page. Also, please be aware of any restrictions to the input data (i.e, temporal resolution, zero-values); these are stated in each function's Inputs section. For functions which input multiple data types (excluding CMMS data), ensure the timestamps are consistent throughout each data.

Frequently asked questions

  • Why are my results not ready yet?

    • Though your data have been uploaded, it will take time for the function to process the data and generate your results. Ensure that you keep the link that you are provided to download and view your results and regularly check the status of the analysis.

  • How long will it take to generate my results?

    • Depending on the function you selected, and the amount of data inputted, the function can take anywhere between a few seconds to several minutes to process the data and generate results. Functions which invoke the genetic algorithm (i.e., AHU anomaly detection, baseline energy performance, end-use disaggregation) may take upwards of half an hour to process. Regularly check the status of your analysis.

  • What does the "queue #" mean?

    • Currently, the toolkit can only process one function at a time (i.e., multiple functions cannot be run simultaneously). Operating on a "first come, first serve" basis, data uploaded prior to your's are processed first before your data are processed. If the queue # is equal to one (1), your data are currently being processed.

  • What went wrong with the analysis?

    • If you are presented with "Something went wrong with the analysis," ensure the input data is formatted as prescribed by the function; the input format is outlined in each function's Input section. Also ensure that the data (excluding column headers, timestamps, and CMMS data) contains only numerical values. Non-numerical values (i.e., - , & , % , @) cannot be accepted. Be aware of any minimum data requirements that some functions impose. If you are still experiencing this problem, please contact andre.markus@carleton.ca for assistance.

  • What happens to the uploaded data after they are uploaded/processed?

    • Once the data have been processed, regardless if the analysis was successful or not, the uploaded data are permanently deleted. However, the generated reports are deleted periodically.