Insights done to first order

Still need to do Portfolio Summary, but have to understand how it works first, and decided to go ahead and commit everything else first. Default reports is a bit funky because there are bugs that haven't been fixed yet.
SEED-platform · Oct 16, 2024 · d5b4299 · d5b4299
1 parent a210d35
commit d5b4299
Show file tree

Hide file tree

Showing 19 changed files with 132 additions and 26 deletions.
diff --git a/docs/images/insights_configuration_01.png b/docs/images/insights_configuration_01.png
diff --git a/docs/images/insights_configuration_02.png b/docs/images/insights_configuration_02.png
diff --git a/docs/images/insights_configuration_03.png b/docs/images/insights_configuration_03.png
diff --git a/docs/images/insights_configuration_04.png b/docs/images/insights_configuration_04.png
diff --git a/docs/images/insights_configuration_05.png b/docs/images/insights_configuration_05.png
diff --git a/docs/images/insights_configuration_06.png b/docs/images/insights_configuration_06.png
diff --git a/docs/images/insights_configuration_07.png b/docs/images/insights_configuration_07.png
diff --git a/docs/images/insights_customReport.png b/docs/images/insights_customReport.png
diff --git a/docs/images/insights_custom_reports_02.png b/docs/images/insights_custom_reports_02.png
diff --git a/docs/images/insights_custom_reports_03.png b/docs/images/insights_custom_reports_03.png
diff --git a/docs/images/insights_default_reports_02.png b/docs/images/insights_default_reports_02.png
diff --git a/docs/images/insights_default_reports_03.png b/docs/images/insights_default_reports_03.png
diff --git a/docs/images/insights_default_reports_04.png b/docs/images/insights_default_reports_04.png
diff --git a/docs/images/insights_program_configuration_button.png b/docs/images/insights_program_configuration_button.png
diff --git a/docs/images/insights_program_overview_configuration.png b/docs/images/insights_program_overview_configuration.png
diff --git a/docs/images/insights_property_insights_02.png b/docs/images/insights_property_insights_02.png
diff --git a/docs/images/insights_property_insights_03.png b/docs/images/insights_property_insights_03.png
diff --git a/docs/images/insights_property_insights_04.png b/docs/images/insights_property_insights_04.png
diff --git a/docs/user_doc_insights.md b/docs/user_doc_insights.md
@@ -54,69 +54,175 @@ Insights can be used to compare metrics for building portfolios or individual bu
 	Details coming soon
 
 
+??? note "Program Configuration"
+	## Program Configuration
+	The Program Configuration screen is where the set up for a given "program" is defined
+
+	### Setting up the Data
+
+	Because Insights is used to look at trends over time, it is necessary to import data over time in different cycles
+	![](images/insights_configuration_01.png)
+
+	- Import metrics (ie, Site EUI or GHG emissions) for each building as well as targets for those metrics
+	- Define "drived fields" to calculate target "deltas" if that is useful
+
+	![](images/insights_configuration_02.png)
+
+	### Program Configuration
+	Click on the Program Configuration link to define the criteria for these "program" report
+	![](images/insights_configuration_03.png)
+
+	There are three components to define on the Program Configuration page:
+
+	- General Settings
+	- Metric Type Settings
+	- Visualization Settings
+
+	![](images/insights_configuration_04.png)
+
+	#### General Settings
+	For a new program, click the green New Program button, and the information under General Settings will be blank
+
+	- Change the "New Program" name to the desired name
+	- Choose the Cycles to use
+	- Choose the Filter Group to use
+
+	![](images/insights_configuration_05.png)
+
+	#### Metric Type Settings
+
+	This section is where the compliance between the actual and the target metrics are defined
+
+	![](images/insights_configuration_06.png)
+
+	#### Visualization Settings
+
+	The Visualization Settings determine the X-Axis options in the Property Insights view
+
+	![](images/insights_configuration_07.png)
+
+
 ??? note "Program Overview"
 	## Program Overview
 
-	The Program Overview option shows portfolio compliance with a performance target over time (cycles)
+	The **Program Overview** option shows portfolio compliance with a performance target over time (cycles)
 
 	![](images/insights_program_overview_01.png)
 
+	###Program Configuration
+
+	Click the **Program Configuration** button to set up the metrics to compare
 
+	![](images/insights_program_configuration_button.png)
+
+	In this example, the configuration setting are:
+
+	**GENERAL SETTINGS**
+
+	- **Cycles:** This EUI Comparison program is looking at data from 2019 - 2023
+	- **Filter Group:** For this program, the filter group includes all buildings. If multiple Filter Groups are defined, more than one Filter Group can be selected here
+
+	** METRIC TYPE SETTINGS**
+
+	- **Metrics:** Site EUI
+	- **Actual Value:** Site EUI (kBtu/ft2/year), from the pulldown list of fields for the building
+	- **Target Value:** Site EUI Target (kBtu/ft2/year), from the pulldown list of fields for the building
+	- **Type:** This setting defines "compliance". In this case, the Target EUI value must be larger than the Actual EUI value, meaning the building's actual site EUI is less than the target set for that building
+
+	![](images/insights_program_overview_configuration.png)
+
 
 
 ??? note "Property Insights"
 	## Property Insights
 
-	x
+	The **Property Insights** option shows the compliance status for individual buildings, again based on the program configuration settings.
+
+	In the example below, the program being viewed has the following selections:
+
+	- **Program:** EUI Comparison 
+	- **Cycle:** 2022
+	- **Metric Type:** Energy metric (in this example, only energy metric is defined)
+	- **X Axis:** Property Type
+
+	![](images/insights_property_insights_02.png)
+
+	Hovering over an individual point displays information about the property
+
+	Clicking on that point will open the Inventory Detail view for that building
+
+	![](images/insights_property_insights_03.png)
+
+	Below the graph is a small table which shows the number of Compliant and Non-Compliant buildings. Clicking on either section will display a list of the individual buildings with each status. 
+
+	Clicking on an individual building will open the Inventory Detail view for that building.
+
+	![](images/insights_property_insights_04.png)
+
+	###Program Configuration
 
-	### x
+	The **Program Configuration** set up for the **Program Overview** also controls the information shown here in **Property Insights**, repeated here for completeness.
 
-	- x
+	Click the **Program Configuration** button to set up the metrics to compare
 
-	### x
+	![](images/insights_program_configuration_button.png)
+
+	In this example, the configuration setting are:
+
+	**GENERAL SETTINGS**
+
+	- **Cycles:** This EUI Comparison program is looking at data from 2019 - 2023
+	- **Filter Group:** For this program, the filter group includes all buildings. If multiple Filter Groups are defined, more than one Filter Group can be selected here
 
-	x
+	** METRIC TYPE SETTINGS**
+
+	- **Metrics:** Site EUI
+	- **Actual Value:** Site EUI (kBtu/ft2/year), from the pulldown list of fields for the building
+	- **Target Value:** Site EUI Target (kBtu/ft2/year), from the pulldown list of fields for the building
+	- **Type:** This setting defines "compliance". In this case, the Target EUI value must be larger than the Actual EUI value, meaning the building's actual site EUI is less than the target set for that building
+
+	![](images/insights_program_overview_configuration.png)
 
 
 ??? note "Default Reports"
 	## Default Reports
 
-	x
+	Default reports allow graphing of different metrics
 
-	### x
+	![](images/insights_default_reports_01.png)
 
-	x
+	#### Property Reports Settings
 
-	#### x
-	x
-
-	**x**
-	x
+	![](images/insights_default_reports_03.png)
 
-	x
+	This section of the page defines what data will be plotted, based on the selection of:
 
-	### x
+	- Cycles to include
+	- X Axis metric
+	- Y Axis metric
 
-	1. x
-	![](images/analyses_BETTER_select_analysis.png)
+	![](images/insights_default_reports_04.png)
 
 
 ??? note "Custom Reports"
 	## Custom Reports
 
-	### x
+	Custom Reports show the metric trend over time for a collection of buildings
+
+	![](images/insights_customReport.png)
+
+	**Config**
 
-	- x
+	The **Config** option in the upper right controls the display (or not) of the configuration settings. If it is "off", the display of the graph has more room on the web page
 
-	### x
+	![](images/insights_custom_reports_02.png)
 
-	- x
+	The table below the graph can be expanded to show the individual properties, and clicking on the buildings will display the Inventory Detail view for the property.
+
+	![](images/insights_custom_reports_03.png)
 
 
 
 ??? note "Portfolio Summary"
-	## Portfolio Summary
-
-	### x
 
-	- x
+	Details coming soon