Indicator Tutorial (Solar Panels): Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
This tutorial guides you through the steps that are necessary to build your own simple [[Indicator|Indicator]] using [[Excel|excel]] and [[TQL|TQL]].
This tutorial guides you through the steps that are necessary to build your own simple [[Indicator|Indicator]] using [[Excel|excel]] and [[TQL|TQL]].
In this example, an Indicator is build that calculates the amount of (different kinds of) houses with solar panels that are present in a neighbourhood.  
In this example, an Indicator is build that calculates the amount of (different kinds of) houses with solar panels that are present in a neighbourhood.  
You can use this tutorial in several ways:
1. To practise building your own Indicator from scratch. Please note that for this, a good level of experience with working with Excel is required.
2. To learn of what elements an Indicator consists, and to be able to adjust excisting Indicators to your own wishes. For this, do not only start with downloading the dummy Indicator (step 1 underneath), but also download the example Indicator in the [https://store.tygron.com/ Tygron Index] named 'Houses with Solar Panels' straigt away, and compare both for each step.


==Steps==
==Steps==


{{Editor steps|title=create an 'Amount of Houses with Solar Panels' Indicator
{{Editor steps|title=create an 'Amount of Houses with Solar Panels' Indicator
|Download the 'Dummy Indicator' from the [https://store.tygron.com/ Tygron Index]. Use this as a starting point for your own indicator
|Download the 'Dummy Indicator' from the [https://store.tygron.com/ Tygron Index]. Use this as a starting point for your own Indicator.
|Explore the Dummy Indicator.
*Note that the grey area in the Dummy Indicator is meant for requesting information from the Tygron Platform using queries (TQL).
*The light blue area is meant for calculations - for instance adding and subtracting data from the Platform.
*The area on the far right is the html table meant for presenting the results.
|Check which (housing) [[Functions|Functions]] with solar panels are present in the {{software}}.
|Check which (housing) [[Functions|Functions]] with solar panels are present in the {{software}}.
|Compose the right [[TQL|TQL]] query necessary tot determine the amount of housing functions with solar panels per neighbourhood
|Compose the right [[TQL|TQL]] queries necessary tot determine the amount of housing functions with solar panels per neighbourhood. Note that you need information about which neighbourhoods are present, how many houses
|Determine and Fill in the required calculations in your Excel Indicator. For instance, the increase amount of houses with solar panels is obtained by subtracting the amount in the Current state from the amount in the Maquette.
|Think of how you want to show the results in the table in the Indicator panel and fill in the [[HTML|html]] table according to this
|Think of how you want to show the results in the table in the Indicator panel and fill in the [[HTML|html]] table according to this
|[[Indicators#Editing Indicators|Add the Indicator]] to your project and test it.  
|[[Indicators#Editing Indicators|Add the Indicator]] to your project and test it.  

Revision as of 10:03, 6 May 2019

This tutorial guides you through the steps that are necessary to build your own simple Indicator using excel and TQL. In this example, an Indicator is build that calculates the amount of (different kinds of) houses with solar panels that are present in a neighbourhood.


You can use this tutorial in several ways: 1. To practise building your own Indicator from scratch. Please note that for this, a good level of experience with working with Excel is required.

2. To learn of what elements an Indicator consists, and to be able to adjust excisting Indicators to your own wishes. For this, do not only start with downloading the dummy Indicator (step 1 underneath), but also download the example Indicator in the Tygron Index named 'Houses with Solar Panels' straigt away, and compare both for each step.

Steps

How to create an 'Amount of Houses with Solar Panels' Indicator:
  1. Download the 'Dummy Indicator' from the Tygron Index. Use this as a starting point for your own Indicator.
  2. Explore the Dummy Indicator.
  • Note that the grey area in the Dummy Indicator is meant for requesting information from the Tygron Platform using queries (TQL).
  • The light blue area is meant for calculations - for instance adding and subtracting data from the Platform.
  • The area on the far right is the html table meant for presenting the results.
  1. Check which (housing) Functions with solar panels are present in the Tygron Platform.
  2. Compose the right TQL queries necessary tot determine the amount of housing functions with solar panels per neighbourhood. Note that you need information about which neighbourhoods are present, how many houses
  3. Determine and Fill in the required calculations in your Excel Indicator. For instance, the increase amount of houses with solar panels is obtained by subtracting the amount in the Current state from the amount in the Maquette.
  4. Think of how you want to show the results in the table in the Indicator panel and fill in the html table according to this
  5. Add the Indicator to your project and test it.
  6. Optional: upgrade your Indicator. Add a column with the resources provided with the Solar Panels. Make an assumption for the resources per house with Solar Panels.


An example of an Indicator that was build following these steps can be found in the Tygron Index named 'Houses with Solar Panels'.

Also see

Tutorial: How to implement Indicators in the Tygron Platform