-
Notifications
You must be signed in to change notification settings - Fork 2
How to use Joule
This is a little user guide for Joule v4.0
As you open the page, Joule loads the configuration file and shows the default chart. A custom configuration file can be used by appending #config=URL to the app's URL, where URL is the URL of the customised config.json file.
Either Power consumption or CO2 production can be shown by selecting the appropriate element from the drop-down list.
Three types of chart are available:
# Line chart
The lines to plot can be selected from the tree on the left. A maximum of 10 lines (the number depends on the configuration) can be plotted simultaneously.
The chart is made up of two similar charts: a big focus chart and a small context chart. When the data is loaded it appears in the context chart. Data to be visualised in the focus chart can be set by drag-selecting the desired area on the context chart. The selected area can be zoomed in by using the mouse wheel on the focus chart.
The scale on the Y axis can be set to span between zero and the maximum of all the loaded data (All data), zero and the maximum of the selected data (Selection), or the minimum and maximum of the selected data (Zoom selection).
Start and end date/time set the time frame for which the data is loaded. The minimum date for which data is available is defined in the configuration and the selection tool prevents the user from selecting an invalid date, be it before the minimum date or after the end date. This selection sets the data to be displayed in the context chart. The default range is set in the configuration file.
Toggles a Gaussian filter to the data in order to remove high frequency components.
Toggles the visibility of the gradients beneath the lines.
# Sankey diagram
The date of the current shown instant is printed on the diagram.
The nodes can be dragged and moved vertically. Double clicking on a non-root node will set it as the root node. Double clicking on a root node will show the previous level.
Shows the parent level of the root node up to the master root (eg. Building).
Sets the maximum depth of the sankey diagram, or the maximum generation from the oldest ancestor to be shown.
Start and end date/time set the time frame for which the data is loaded. The minimum date for which data is available is defined in the configuration and the selection tool prevents the user from selecting an invalid date, be it before the minimum date or after the end date. The default range is set in the configuration file.
Sets the level of detail: the data is averaged hourly, daily, weekly, or monthly. This sets the step at which the animation occurs.
The animation control buttons are used to move in time by a step defined by the interval selector. The buttons are used in the order to: go back by one step, play from the first to the last step (which becomes pause on play), increase the speed of the animation, go forward by one step.
# Treemap
This chart shows a treemap representation of the tree with values given by the average of the data in the chosen range. The description printed on the chart is the parent of the areas (children) shown.
Clicking on an area which has children will zoom into that area making the children visible. Clicking on the description will zoom out the area.
Start and end date/time set the time frame for which the data is loaded. The minimum date for which data is available is defined in the configuration and the selection tool prevents the user from selecting an invalid date, be it before the minimum date or after the end date. The default range is set in the configuration file. The values shown in the treemap are a simple average of the data over the selected period.