Net Wizard: Difference between revisions
| (30 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
* '''Active''': Whether the network is active and visible. | * '''Active''': Whether the network is active and visible. | ||
* {{Anchor|NET_OWNER}}'''Net Owner''': The [[stakeholder]] that owns a particular network. | * {{Anchor|NET_OWNER}}'''Net Owner''': The [[stakeholder]] that owns a particular network. | ||
* {{Anchor|NET_TYPE_TIME_STATE}}'''Connection Status''': The | * {{Anchor|NET_TYPE_TIME_STATE}}'''Connection Status''': The [[Net Load#Time State|connection status]] of existing Loads of the selected Net Type. | ||
* '''Net Function''': The default Net Function that is used to generate [[Net Line]]s. | * '''Net Function''': The default Net Function that is used to generate [[Net Line]]s. | ||
** {{Anchor|DIAMETER_M}}'''Diameter M''': The default diameter for [[Net Line]]s | ** {{Anchor|DIAMETER_M}}'''Diameter M''': The default diameter for [[Net Line]]s | ||
| Line 14: | Line 14: | ||
===Load generation=== | ===Load generation=== | ||
[[Net load]]s can be generated based on buildings and the addresses within them. When selecting this option, you can select which [[neighborhood]], [[stakeholder]], and [[building]] [[category]] to generate loads for. Load generation makes use of the following settings: | [[Net load]]s can be generated based on buildings and the addresses within them. When selecting this option, you can select which [[neighborhood]], [[stakeholder]], and [[building]] [[category]] to generate loads for. Load generation makes use of the following settings: | ||
* '''Address Threshold''': When the building has more than this many addresses, rather than generate an individual load for each address one single load is created for the entire building. | * {{Anchor|ADDRESS_THRESHOLD}}'''Address Threshold''': When the building has more than this many addresses, rather than generate an individual load for each address one single load is created for the entire building. | ||
* '''Floors Threshold''': When the building has more than this many floors, rather than generate an individual load for each address one single load is created for the entire building. | * {{Anchor|FLOORS_THRESHOLD}}'''Floors Threshold''': When the building has more than this many floors, rather than generate an individual load for each address one single load is created for the entire building. | ||
* {{Anchor|SKIP_BUILDINGS_WITH_LOADS}}'''Skip buildings with Load''': When a building already has a load in it, that building is no longer checked to see whether loads have to be generated in it. The building is skipped. | * {{Anchor|SKIP_BUILDINGS_WITH_LOADS}}'''Skip buildings with Load''': When a building already has a load in it, that building is no longer checked to see whether loads have to be generated in it. The building is skipped. | ||
* {{Anchor|CREATE_PATHS}}'''Create Paths''': Whether to also generate the [[net line]]s for the network in the same process. This is often desirable, as a network is not valid when there are net loads unconnected to the net lines. | * {{Anchor|CREATE_PATHS}}'''Create Paths''': Whether to also generate the [[net line]]s for the network in the same process. This is often desirable, as a network is not valid when there are net loads unconnected to the net lines. | ||
===Adjust Loads=== | |||
Once generated, Net Loads can be inspected in the corresponding step. The following properties are shown: | |||
* {{Anchor|FLOW}}'''Flow (GJ)''': The requested amount of Flow for this load. | |||
* {{Anchor|POWER}}'''Power (kW)''': The requested amount of Power for this load. | |||
* {{Anchor|CONNECTION_COUNT}}'''Connections''': A load can represent one or multiple connections. For example, a set of connections within a large appartment building. | |||
* {{Anchor|CONNECTION_COST}}'''Connection Cost''': Fixed cost for installing and connecting this load to the network | |||
* {{Anchor|TYPE}}'''Type code''': A Type code usable by a calculation model to categorize loads. | |||
===Path generation=== | ===Path generation=== | ||
| Line 36: | Line 44: | ||
===={{Anchor|MAP_SECTORS}}Map Sectors==== | ===={{Anchor|MAP_SECTORS}}Map Sectors==== | ||
The map is divided into squares of equal sides, dubbed "sectors". All buildings are checked to see in which sector they reside the most, so that each is considered part of exactly one map sector. All loads in all buildings in the same sector are grouped in the same cluster. This algorithm makes use of the following settings: | The map is divided into squares of equal sides, dubbed "sectors". All buildings are checked to see in which sector they reside the most, so that each is considered part of exactly one map sector. All loads in all buildings in the same sector are grouped in the same cluster. This algorithm makes use of the following settings: | ||
* The size of the sectors in which the map is divided. This is a numeric setting, indicating the side of one edge of the sectors in meters. | * {{Anchor|MAP_SECTOR_SIDE_LENGTH}}'''Sector side (m)''': The size of the sectors in which the map is divided. This is a numeric setting, indicating the side of one edge of the sectors in meters. | ||
* Whether to cluster [[net loads|collective loads]] separately. This is a yes-or-no option. If this option is selected, collective net loads are placed in individual clusters, and not grouped into the cluster generated based on the sectors in which they reside. | * {{Anchor|COLLECTIVE_SEPARATE}}'''Cluster collective loads separate''': Whether to cluster [[net loads|collective loads]] separately. This is a yes-or-no option. If this option is selected, collective net loads are placed in individual clusters, and not grouped into the cluster generated based on the sectors in which they reside. | ||
* | * {{Anchor|DEFAULT_STAKEHOLDER}}'''Default Stakeholder''': When a net load has an owner (because the net load is linked to a building), the net load is considered to be owned by that stakeholder. When the net load does not have an owner, it is considered to be owned by the default stakeholder selected. | ||
===={{Anchor|PER_ATTRIBUTE}}Per attribute==== | ===={{Anchor|PER_ATTRIBUTE}}Per attribute==== | ||
An [[attribute]] of the net loads indicates in which cluster the net load is placed. Every net load with the same value for that attribute is placed in the same cluster. This algorithm makes use of the following settings: | An [[attribute]] of the net loads indicates in which cluster the net load is placed. Every net load with the same value for that attribute is placed in the same cluster. This algorithm makes use of the following settings: | ||
* | * {{Anchor|FILTER_ATTRIBUTE}}'''Filter Attribute''': When 2 or more loads have the same value for this attribute, they are placed in the same cluster. Net loads which do not have this attribute explicitly defined are ignored. | ||
* Whether to cluster [[net loads|collective loads]] separately. This is a yes-or-no option. If this option is selected, collective net loads are placed in individual clusters, and not grouped in a cluster with other net loads which share the same attribute value. | * '''Cluster collective loads separate''': Whether to cluster [[net loads|collective loads]] separately. This is a yes-or-no option. If this option is selected, collective net loads are placed in individual clusters, and not grouped in a cluster with other net loads which share the same attribute value. | ||
* The default stakeholder. When a net load has an owner (because the net load is linked to a building), the net load is considered to be owner by that stakeholder. When the net load does not have an owner, it is considered to be owned by the default stakeholder selected. | * '''The default stakeholder'''. When a net load has an owner (because the net load is linked to a building), the net load is considered to be owner by that stakeholder. When the net load does not have an owner, it is considered to be owned by the default stakeholder selected. | ||
===={{Anchor|PER_BUILDING}}Per building==== | ===={{Anchor|PER_BUILDING}}Per building==== | ||
All the net loads linked to the same building are placed in the same cluster. Each building with net loads will have their own cluster. Net loads which are not linked to buildings are not clustered. If a building already has a cluster and more unclustered loads exist linked to the same building, a new cluster is created for the loads which were not yet clustered. This algorithm makes use of the following settings: | All the net loads linked to the same building are placed in the same cluster. Each building with net loads will have their own cluster. Net loads which are not linked to buildings are not clustered. If a building already has a cluster and more unclustered loads exist linked to the same building, a new cluster is created for the loads which were not yet clustered. This algorithm makes use of the following settings: | ||
* Whether to cluster [[net loads|collective loads]] separately. This is a yes-or-no option. If this option is selected, collective net loads are placed in individual clusters, and not grouped in a cluster with other net loads linked to the same building. | * '''Cluster collective loads separate''': Whether to cluster [[net loads|collective loads]] separately. This is a yes-or-no option. If this option is selected, collective net loads are placed in individual clusters, and not grouped in a cluster with other net loads linked to the same building. | ||
===={{Anchor|PER_LOAD}}Per load==== | ===={{Anchor|PER_LOAD}}Per load==== | ||
Each net load will be placed in a separate cluster. This algorithm makes use of the following settings: | Each net load will be placed in a separate cluster. This algorithm makes use of the following settings: | ||
* | * '''Default Stakeholder''': When a net load has an owner (because the net load is linked to a building), the net load is considered to be owner by that stakeholder. When the net load does not have an owner, it is considered to be owned by the default stakeholder selected. | ||
====Per load with unique stakeholders==== | ===={{Anchor|PER_LOAD_UNIQUE_OWNER}}Per load with unique stakeholders==== | ||
Each net load will be placed in a separate cluster. Additionally, for each cluster created with this algorithm an additional [[stakeholder]] is added to the project. This algorithm makes use of the following settings: | Each net load will be placed in a separate cluster. Additionally, for each cluster created with this algorithm an additional [[stakeholder]] is added to the project. This algorithm makes use of the following settings: | ||
* The default stakeholder. When a net load has an owner (because the net load is linked to a building), the net load is considered to be owner by that stakeholder. When the net load does not have an owner, it is considered to be owned by the default stakeholder selected. | * The default stakeholder. When a net load has an owner (because the net load is linked to a building), the net load is considered to be owner by that stakeholder. When the net load does not have an owner, it is considered to be owned by the default stakeholder selected. | ||
====Add to existing clusters by building==== | ===={{Anchor|ADD_TO_EXISTING_FOR_BUILDINGS}}Add to existing clusters by building==== | ||
For each cluster, all net loads are checked for the buildings to which they are linked. Those buildings are checked for net loads which are linked to that building but are not yet clustered. If any unclustered net loads are found in buildings this way, those net loads are added to the existing cluster. If multiple net loads, part of different clusters, are linked to the same building, it is random to which cluster any unclustered net loads will be added. This algorithm does not have any settings. | For each cluster, all net loads are checked for the buildings to which they are linked. Those buildings are checked for net loads which are linked to that building but are not yet clustered. If any unclustered net loads are found in buildings this way, those net loads are added to the existing cluster. If multiple net loads, part of different clusters, are linked to the same building, it is random to which cluster any unclustered net loads will be added. This algorithm does not have any settings. | ||
==Panels== | |||
[[Template Panel]]s are used as a blue print for interaction Panels. when applied, template panels create instances for the related Clusters. Template panels can have an owner different from the underlying clusters. E.g. when a Net Owner is allowed to alter the state of a Net Cluster. | |||
The following properties of a Template Panel can be adjusted in this step: | |||
* {{Anchor|WIDTH}}'''Width''': The width of this panel in pixels. | |||
* {{Anchor|HEIGHT}}'''Height''': The height of this panel in pixels. | |||
Currently only Template Excel Panels can be selected. | |||
==Visualization== | |||
The following settings can be adjusted in the visualization step of the Net Wizard: | |||
*{{Anchor|REQUIRE_APPROVAL_NETOWNER}}'''Netowner approval required''': This setting can be used by interaction panels to enable or disable permission requests for the Netowner. In case it is turned of, the Netowner does not need to give permission for a connect request. Please note that adjusting this setting only works if the supplied interaction panels use this setting! | |||
*{{Anchor|DIRECT_CONNECT_FIRST_REQUEST}}'''Direct connect first request''': This setting can be used by interaction panels to set the state of a load directly to connected the first time a connection request is selected. In further connection requests, the Netowner must give permission. Please note that adjusting this setting only works if the supplied interaction panels use this setting! | |||
*{{Anchor|CLUSTER_MODELS}}'''Show Cluster Models''': Show 3D models of Clusters. The models use the color of the Stakeholder owning this Cluster. The chosen model, individual or combined, is currently dependent on the type of first Load of the Cluster. Individual is chosen if the type of the first Load is ''INDIVIDUAL'' (5). | |||
*{{Anchor|NET_LOAD_LINES}}'''Show Node to Load lines''': Show 3D lines from Node of Load to the offset point of the Load. The offset point is ofter the location of the main address of the Load. This setting is useful for debugging, because it show if the configured main address matches the node position from a provided GIS or network file. However, this setting is preferable disabled for sessions, because it can lead to confusion. | |||
*{{Anchor|DEFAULT_FRACTION_CONNECTED}}'''Default fraction connected''': This setting can be used by interaction panels to set the fraction of loads within a cluster that are activated once requested. E.g. 0.5 indicates that only 50 percent of the loads are activated when the cluster owner or the net owner requests the activation of this cluster. Please note that adjusting this setting only works if the supplied interaction panels use this setting! | |||
{{Editor current situation nav}} | |||
[[Category:Network]][[Category:How-to's]] | [[Category:Network]][[Category:How-to's]] | ||
Latest revision as of 10:07, 8 October 2026
It is possible to let the Tygron Platform generate a network for you. This can be done using the Net wizard, which will guide you through the process. Specific steps are explained in more detail below.
Net Settings
First networks have to be activated before a network can be generated. A network is always of a particular Net Type. Each network has the following settings:
- Active: Whether the network is active and visible.
- Net Owner: The stakeholder that owns a particular network.
- Connection Status: The connection status of existing Loads of the selected Net Type.
- Net Function: The default Net Function that is used to generate Net Lines.
Load generation
Net loads can be generated based on buildings and the addresses within them. When selecting this option, you can select which neighborhood, stakeholder, and building category to generate loads for. Load generation makes use of the following settings:
- Address Threshold: When the building has more than this many addresses, rather than generate an individual load for each address one single load is created for the entire building.
- Floors Threshold: When the building has more than this many floors, rather than generate an individual load for each address one single load is created for the entire building.
- Skip buildings with Load: When a building already has a load in it, that building is no longer checked to see whether loads have to be generated in it. The building is skipped.
- Create Paths: Whether to also generate the net lines for the network in the same process. This is often desirable, as a network is not valid when there are net loads unconnected to the net lines.
Adjust Loads
Once generated, Net Loads can be inspected in the corresponding step. The following properties are shown:
- Flow (GJ): The requested amount of Flow for this load.
- Power (kW): The requested amount of Power for this load.
- Connections: A load can represent one or multiple connections. For example, a set of connections within a large appartment building.
- Connection Cost: Fixed cost for installing and connecting this load to the network
- Type code: A Type code usable by a calculation model to categorize loads.
Path generation
Net lines can be generated automatically, based on the net loads present in the project map (or when generating as part of the process of generating net loads, also based on the net loads generated by the net load generation process). When selecting this option, you can select the net line definitions the generated net lines should be based on. Network generation makes use of the following settings:
- Merge range: While generating a path from a net load, if there is an existing node closer than this to the most recently placed node, the path is directly connected to that node. This can pass through obstacles. This means the path generation algorithm will directly clip to the existing network, and the path will be completed for the currently treated net load.
- Search range: While generating a path from a net load to the root, if there is an existing node closer than this to the most recently placed node, and a potential path to it is not a significant detour, the path will be generated towards that node instead of the root. This means the path generation algorithm will change course to meet an existing path.
The search range is generally for the behavior of connecting new sections of a network to an existing network. The merge range is generally for creating the final connections between net loads and existing networks.
When generating net lines, a root load must be placed somewhere in the project map, from where the network will be generated*. If a root load does not yet exist, an option will be offered to place a root load in the project using the 3D Visualization.
* Strictly speaking, the network generation algorithm will work its way from unconnected net loads to the node connected to the root node.
Cluster generation
There are a number of ways to have clusters generated by the Tygron Platform. When selecting this option, you can select which neighborhoods and stakeholders to cluster for. Net loads which are already clustered will not be removed from their clusters or moved to other clusters. Net loads which are not located in the selected neighborhoods are not taken into consideration (Note that this is the position of the net load and not of its connected net node). Net loads which are taken into consideration are not limited by their neighborhoods. This means net loads from different neighborhoods can be placed in the same cluster. No matter the used algorithm, clusters will always only contain net loads of the same stakeholder.
Map Sectors
The map is divided into squares of equal sides, dubbed "sectors". All buildings are checked to see in which sector they reside the most, so that each is considered part of exactly one map sector. All loads in all buildings in the same sector are grouped in the same cluster. This algorithm makes use of the following settings:
- Sector side (m): The size of the sectors in which the map is divided. This is a numeric setting, indicating the side of one edge of the sectors in meters.
- Cluster collective loads separate: Whether to cluster collective loads separately. This is a yes-or-no option. If this option is selected, collective net loads are placed in individual clusters, and not grouped into the cluster generated based on the sectors in which they reside.
- Default Stakeholder: When a net load has an owner (because the net load is linked to a building), the net load is considered to be owned by that stakeholder. When the net load does not have an owner, it is considered to be owned by the default stakeholder selected.
Per attribute
An attribute of the net loads indicates in which cluster the net load is placed. Every net load with the same value for that attribute is placed in the same cluster. This algorithm makes use of the following settings:
- Filter Attribute: When 2 or more loads have the same value for this attribute, they are placed in the same cluster. Net loads which do not have this attribute explicitly defined are ignored.
- Cluster collective loads separate: Whether to cluster collective loads separately. This is a yes-or-no option. If this option is selected, collective net loads are placed in individual clusters, and not grouped in a cluster with other net loads which share the same attribute value.
- The default stakeholder. When a net load has an owner (because the net load is linked to a building), the net load is considered to be owner by that stakeholder. When the net load does not have an owner, it is considered to be owned by the default stakeholder selected.
Per building
All the net loads linked to the same building are placed in the same cluster. Each building with net loads will have their own cluster. Net loads which are not linked to buildings are not clustered. If a building already has a cluster and more unclustered loads exist linked to the same building, a new cluster is created for the loads which were not yet clustered. This algorithm makes use of the following settings:
- Cluster collective loads separate: Whether to cluster collective loads separately. This is a yes-or-no option. If this option is selected, collective net loads are placed in individual clusters, and not grouped in a cluster with other net loads linked to the same building.
Per load
Each net load will be placed in a separate cluster. This algorithm makes use of the following settings:
- Default Stakeholder: When a net load has an owner (because the net load is linked to a building), the net load is considered to be owner by that stakeholder. When the net load does not have an owner, it is considered to be owned by the default stakeholder selected.
Per load with unique stakeholders
Each net load will be placed in a separate cluster. Additionally, for each cluster created with this algorithm an additional stakeholder is added to the project. This algorithm makes use of the following settings:
- The default stakeholder. When a net load has an owner (because the net load is linked to a building), the net load is considered to be owner by that stakeholder. When the net load does not have an owner, it is considered to be owned by the default stakeholder selected.
Add to existing clusters by building
For each cluster, all net loads are checked for the buildings to which they are linked. Those buildings are checked for net loads which are linked to that building but are not yet clustered. If any unclustered net loads are found in buildings this way, those net loads are added to the existing cluster. If multiple net loads, part of different clusters, are linked to the same building, it is random to which cluster any unclustered net loads will be added. This algorithm does not have any settings.
Panels
Template Panels are used as a blue print for interaction Panels. when applied, template panels create instances for the related Clusters. Template panels can have an owner different from the underlying clusters. E.g. when a Net Owner is allowed to alter the state of a Net Cluster. The following properties of a Template Panel can be adjusted in this step:
- Width: The width of this panel in pixels.
- Height: The height of this panel in pixels.
Currently only Template Excel Panels can be selected.
Visualization
The following settings can be adjusted in the visualization step of the Net Wizard:
- Netowner approval required: This setting can be used by interaction panels to enable or disable permission requests for the Netowner. In case it is turned of, the Netowner does not need to give permission for a connect request. Please note that adjusting this setting only works if the supplied interaction panels use this setting!
- Direct connect first request: This setting can be used by interaction panels to set the state of a load directly to connected the first time a connection request is selected. In further connection requests, the Netowner must give permission. Please note that adjusting this setting only works if the supplied interaction panels use this setting!
- Show Cluster Models: Show 3D models of Clusters. The models use the color of the Stakeholder owning this Cluster. The chosen model, individual or combined, is currently dependent on the type of first Load of the Cluster. Individual is chosen if the type of the first Load is INDIVIDUAL (5).
- Show Node to Load lines: Show 3D lines from Node of Load to the offset point of the Load. The offset point is ofter the location of the main address of the Load. This setting is useful for debugging, because it show if the configured main address matches the node position from a provided GIS or network file. However, this setting is preferable disabled for sessions, because it can lead to confusion.
- Default fraction connected: This setting can be used by interaction panels to set the fraction of loads within a cluster that are activated once requested. E.g. 0.5 indicates that only 50 percent of the loads are activated when the cluster owner or the net owner requests the activation of this cluster. Please note that adjusting this setting only works if the supplied interaction panels use this setting!