Calculation panel: Difference between revisions
No edit summary |
|||
| (73 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
The Calculation Panel can be found by hovering with your mouse over the | The Calculation Panel helps you to manage the calculation time of your project. The Calculation Panel can be found by hovering with your mouse over the Refresh button, under the File menu tab in the top left corner. | ||
[[File: | [[File:Recalculate panel.JPG||thumb|none|700px]] | ||
The options in this panel will allow you to set up how [[Indicator|indicators]], [[Panel|panels]] and [[Overlay]]s are being (re)calculated and provide an overview of the calculation time of some of the components in your project. For more guidelines on calculation performance see [[Troubleshooting_calculation_performance|Troubleshooting calculation performance]]. | |||
The options in this panel will allow you to | |||
In the top of the panel, you can find information on the total amount of grid cells in your project. This amount of grid cells relates to the [[Grid_Overlay#Grid_size|Grid size]] and influences the performance. | |||
==Auto-update indicators== | |||
The Auto-update option is by default enabled and ensures that whenever you make a change in the Editor, the indicators, panels and overlays will be recalculated immediately. When Auto-update is disabled, you will have to manually refresh the project after making any adjustment. You can refresh the project manually by choosing one of the available options; [[#Scheduled Update (long running)|Scheduled Update (long running)]], [[#Update Indicators and Reset Excel X-Queries|Update Indicators or Reset Excel X-Queries]]. Clicking on the Auto-update button itself triggers the Update Indicators option. | |||
Compare the three different Project Update states below. | |||
<gallery> | |||
File:Auto_update_on2.jpg|150px|Auto update on | |||
File:Auto_update_off2.jpg|150px|Auto update off but the project is up to date | |||
File:Manual_update2.jpg|150px|Auto update is off and manual recalculation is required | |||
</gallery> | |||
==Scheduled Update (long running)== | |||
Calculations are capped at a maximum calculation time of 30 minutes. This means that if a calculation takes longer than 30 minutes it reaches a "timeout" and calculates no further. This is to ensure fair use of the calculation capacity of the {{software}} between all customers. | |||
When a calculation is expected to take longer than 30 minutes, it is possible to schedule a long running calculation. This means the {{software}} allocates specific calculation resources without a time limit, which should not hinder other calculations taking shorter amounts of time. | |||
When scheduling a long running calculation, the user will be prompted whether and how to be alerted when the calculation completes. It's possible to be alerted via email, in which case an email is sent to the email address of the user, or via SMS, in which case an SMS text message will be sent to the user's registered phone number (or one entered at the time of scheduling). It is also possible to forgo an alert. In addition, opting to schedule a long running calculations will automatically put the session in [[Keep Alive]] mode. This means the {{software}} can be closed on the user's computer, and the [[Session]] will remain active, allowing a user to reconnect to the [[Session]] within a week. | |||
Like with shorter calculations, if all calculation resources which allow long running calculations are already in use, the calculation remains queued until resources free up. | |||
<gallery> | <gallery> | ||
File: | File:Scheduled_update_option1.jpg|200px|Scheduled Update (long running) option. | ||
File: | File:ScheduledUpdateNotification1.jpg|200px|Options to be notified (or not). | ||
</gallery> | </gallery> | ||
==Reset Excel X-Queries== | |||
{{main|X query (Excel)#Resetting X queries}} | |||
Often, [[Excel]]s for [[Indicator]]s or [[Panel]]s use [[X-Queries]]. These queries are interpreted by the {{software}} as "for every" of a certain [[Item]]. For example, {code|1=WHERE_AREA_IS_X}} will resolve to multiple queries, one for every Area. These individual queries are then reused whenever a calculation is performed. | |||
When | When new [[Item]]s matching the [[X-Query]] are added, or such [[Item]]s are removed, it is necessary to use the "Reset X-Queries" option, to force the {{software}} to re-evaluate for which [[Item]]s individual queries should be generated. If queries are not reset before performing a new calculation, added [[Item]]s will not be included in the calculation, and removed [[Item]]s will mean queries exist referencing a non-existent [[Item]], which will result in an error. | ||
{{gallery | |||
|Update_Indicators_option1.jpg|Update Indicators option | |||
|ResetExcelXQueries1.jpg|Reset Excel X-Queries option | |||
}} | |||
===When to choose which option?=== | |||
Choose Reset | Choose Reset Excel X-Queries if the amount of [[area]]s or [[neighborhood]]s is changed (for example by adding or removing an area/neighborhood). | ||
Choose | Choose Update Indicators if the amount of areas or neighborhoods stays the same (for example if you only changed an attribute of an area or if you did not use X-Queries in your Excelsheet. | ||
''Using one of these | ''Using any one of these option affects ''all'' [[indicator]]s, [[panel]]s and [[grid Overlay]]s.'' | ||
==Performance overview== | |||
[[File:Performance_overview.JPG|thumb|right| | {{main|Performance Overview}} | ||
[[File:Performance_overview.JPG|thumb|right|200px|Performance overview panel]] | |||
The performance overview shows an overview of the components in a project and their calculation time. If your project performance is slow, check the overview to see which component(s) could cause this. | The performance overview shows an overview of the components in a project and their calculation time. If your project performance is slow, check the overview to see which component(s) could cause this. | ||
{{clear}} | |||
<gallery | ==GPU overview== | ||
File:Busy.JPG| | The GPU cluster overview shows the different GPU clusters that are available for calculation and their status. If they are busy with calculating components of other projects of other users, it will be visible here. Also your own calculation jobs will be visible in the panel and the possibility to cancel your own calculation(s), by clicking on the cancel icon (see image). The GPU clusters where short is stated are used for short calculations (max 30 minutes). The other GPU clusters are available for [[Calculation_panel#Scheduled Update (long running)|Long running scheduled]] calculations. | ||
File:Cancel.JPG| | |||
<gallery> | |||
File:Busy.JPG|200px|One of the clusters is busy with another job | |||
File:Cancel.JPG|200px|The calculation time of one of the components in your project is visible and the option to cancel it | |||
</gallery> | </gallery> | ||
{{article end | |||
|seealso= | |||
*[[Ribbon]] | |||
*[[Grid Overlay]]s | |||
*[[Indicator]]s | |||
|howtos= | |||
*[[How to delay Grid Overlay calculations]] | |||
}} | |||
{{editor ui nav}} | |||
Latest revision as of 10:58, 1 February 2024
The Calculation Panel helps you to manage the calculation time of your project. The Calculation Panel can be found by hovering with your mouse over the Refresh button, under the File menu tab in the top left corner.
The options in this panel will allow you to set up how indicators, panels and Overlays are being (re)calculated and provide an overview of the calculation time of some of the components in your project. For more guidelines on calculation performance see Troubleshooting calculation performance.
In the top of the panel, you can find information on the total amount of grid cells in your project. This amount of grid cells relates to the Grid size and influences the performance.
Auto-update indicators
The Auto-update option is by default enabled and ensures that whenever you make a change in the Editor, the indicators, panels and overlays will be recalculated immediately. When Auto-update is disabled, you will have to manually refresh the project after making any adjustment. You can refresh the project manually by choosing one of the available options; Scheduled Update (long running), Update Indicators or Reset Excel X-Queries. Clicking on the Auto-update button itself triggers the Update Indicators option.
Compare the three different Project Update states below.
Auto update on
Auto update off but the project is up to date
Auto update is off and manual recalculation is required
Scheduled Update (long running)
Calculations are capped at a maximum calculation time of 30 minutes. This means that if a calculation takes longer than 30 minutes it reaches a "timeout" and calculates no further. This is to ensure fair use of the calculation capacity of the Tygron Platform between all customers.
When a calculation is expected to take longer than 30 minutes, it is possible to schedule a long running calculation. This means the Tygron Platform allocates specific calculation resources without a time limit, which should not hinder other calculations taking shorter amounts of time.
When scheduling a long running calculation, the user will be prompted whether and how to be alerted when the calculation completes. It's possible to be alerted via email, in which case an email is sent to the email address of the user, or via SMS, in which case an SMS text message will be sent to the user's registered phone number (or one entered at the time of scheduling). It is also possible to forgo an alert. In addition, opting to schedule a long running calculations will automatically put the session in Keep Alive mode. This means the Tygron Platform can be closed on the user's computer, and the Session will remain active, allowing a user to reconnect to the Session within a week.
Like with shorter calculations, if all calculation resources which allow long running calculations are already in use, the calculation remains queued until resources free up.
Scheduled Update (long running) option.
Options to be notified (or not).
Reset Excel X-Queries
- Main article: X query (Excel)#Resetting X queries
Often, Excels for Indicators or Panels use X-Queries. These queries are interpreted by the Tygron Platform as "for every" of a certain Item. For example, {code|1=WHERE_AREA_IS_X}} will resolve to multiple queries, one for every Area. These individual queries are then reused whenever a calculation is performed.
When new Items matching the X-Query are added, or such Items are removed, it is necessary to use the "Reset X-Queries" option, to force the Tygron Platform to re-evaluate for which Items individual queries should be generated. If queries are not reset before performing a new calculation, added Items will not be included in the calculation, and removed Items will mean queries exist referencing a non-existent Item, which will result in an error.
Update Indicators option
Reset Excel X-Queries option
When to choose which option?
Choose Reset Excel X-Queries if the amount of areas or neighborhoods is changed (for example by adding or removing an area/neighborhood). Choose Update Indicators if the amount of areas or neighborhoods stays the same (for example if you only changed an attribute of an area or if you did not use X-Queries in your Excelsheet.
Using any one of these option affects all indicators, panels and grid Overlays.
Performance overview
- Main article: Performance Overview
The performance overview shows an overview of the components in a project and their calculation time. If your project performance is slow, check the overview to see which component(s) could cause this.
GPU overview
The GPU cluster overview shows the different GPU clusters that are available for calculation and their status. If they are busy with calculating components of other projects of other users, it will be visible here. Also your own calculation jobs will be visible in the panel and the possibility to cancel your own calculation(s), by clicking on the cancel icon (see image). The GPU clusters where short is stated are used for short calculations (max 30 minutes). The other GPU clusters are available for Long running scheduled calculations.
One of the clusters is busy with another job
The calculation time of one of the components in your project is visible and the option to cancel it
