Network: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{learned|what networks are|how networks relate to the Tygron Engine|how networks are structured|how to create networks}}
{{learned|what networks are|how networks relate to the {{software}}|how networks are structured|how to create networks}}
[[Category:Network]]
[[Category:Network]]
{{stub}}


==What is a network==
==What is a network==
A network is broadly defined as an interconnected system of things. More specifically, networks used here are transport and distribution networks. These are systems composed of interconnected points of supply and demand for specific resources, and the routes connecting them.
A network is broadly defined as an interconnected system of things. More specifically, networks used here are transport and distribution networks. These are systems composed of interconnected points of supply and demand for specific resources, and the routes connecting them.


==How networks relate to the Tygron Engine==
==How networks relate to the {{software}}==
In the Tygron Engine, it is possible to add network information to a project.
In the {{software}}, it is possible to add network information to a project.
 
Network functionality is currently an advanced feature, and not available to new projects by default. Please contact Tygron Support if you wish to make use of networks in your projects.


==Network structure==
==Network structure==
Line 15: Line 12:


===Network type===
===Network type===
Each network is related to a predefined resource type. This is known as the network type. The network then is the system through which that resource travels from elements of supply to elements of demand. Each network of a separate type is a separate entity, and networks of different types do not affect each other.
Each network is related to a predefined resource type. This is known as the network type. The network then is the system through which that resource travels from elements of supply to elements of demand. Each network of a separate type is a separate entity, and networks of different types do not affect each other. The following network types are currently available:
* ELECTRICITY
* GAS
* HEAT
* INTERNET


===Network components===
===Network components===
Networks in the engine consist first and foremost out of [[net line]]s and [[net node]]s. The net lines are the principle element in this structure. The two ends of net lines are defined by net nodes. Each net node has at least one net line connected to it, but any arbitrary number of net lines can start or end at a node. The collection of net lines and net nodes between two arbitrary net nodes is called a path.
Networks in the {{software}} consist first and foremost out of [[net line]]s and [[net node]]s. The net lines are the principle element in this structure. The two ends of net lines are defined by net nodes. Each net node has at least one net line connected to it, but any arbitrary number of net lines can start or end at a node. The collection of net lines and net nodes between two arbitrary net nodes is called a path.


Networks also have [[net load]]s, which are a definition of supply and demand. These net loads are linked to net nodes, to indicate the supply and demand on that node. A net load is a geographical element, which should be connected to a net node, with data concerning the amount of supply or demand that net node represents. Not every net node needs to have a net load connected to it. However, net loads are only relevant and valid when they are connected to a net node.
Networks also have [[net load]]s, which are a definition of supply and demand. These net loads are linked to net nodes, to indicate the supply and demand on that node. A net load is a geographical element, which should be connected to a net node, with data concerning the amount of supply or demand that net node represents. Not every net node needs to have a net load connected to it. However, net loads are only relevant and valid when they are connected to a net node.


Lastly, clusters are also used in conjunction with networks. Clusters group together net loads, and serve as an intermediary to use [[TQL|queries]] on the loads of networks, or to add [[panel]]s to the network for reading out information and controlling the network. Clusters are not formally an element of the network. Their existence (or lack thereof) does not inherently influence the validity, functioning, or meaning of the network.
Lastly, clusters are also used in conjunction with networks. Clusters group together net loads, and serve as an intermediary to use [[TQL|queries]] on the loads of networks, or to add [[panel]]s to the network for reading out information and controlling the network. Clusters are not formally an element of the network. Their existence (or lack thereof) does not inherently influence the validity, functioning, or meaning of the network.
===Network settings===
There are a number of settings available with which to tweak how networks functions in your project. For more information on the settings available, see [[Network settings]].


===Restrictions on networks===
===Restrictions on networks===
Line 29: Line 33:
* Behavior for networks linked with buildings which are altered during a session are undefined. When using network functionality, the buildings linked to by the network should not be demolished, [[upgrade]]d, sold to other stakeholders, or otherwise changed.
* Behavior for networks linked with buildings which are altered during a session are undefined. When using network functionality, the buildings linked to by the network should not be demolished, [[upgrade]]d, sold to other stakeholders, or otherwise changed.


==Network settings==
==Adding and editing networks==
There are a number of settings available with which to tweak how networks functions in your project. For more information on the settings available, see [[Network settings]].
Because networks are complex elements in a project, there are multiple topics devoted to creating and verifying your network.
 
===Ways of creating a network===
There are multiple ways to add a network to a project. Depending on the availability of data and the prospective complexity of the network some methods may be more appropriate.
 
====Generating====
It is possible to let the {{software}} [[Generating network|generate a network]] for you. This can be done using the Net wizard, which will guide you through the process.
{{Editor location|Net Wizard}}
 
====Importing Data====
 
{{stub|type=section}}


==Generating Networks==
====Manually====
It is possible to have the Tygron Engine generate networks for your projects.
Although not very practical, it is possible to create or edit networks manually, by placing [[net line]]s and [[net load]]s in the world piece by piece.


==Checking for errors==
===Checking for errors===
When there is doubt on whether the network has been created correctly, there are options to have the engine check for issues automatically.
When there is doubt on whether the network has been created correctly, there are options to have the {{software}} check for issues automatically.


===Network wizard===
====Network wizard====
When creating or importing network data using the net wizard, but also when stepping through the available steps of the wizard without effecting any changes, there are 2 validation steps where all preceding information is checked. These validation steps will check the following for all active network types:
When creating or importing network data using the net wizard, but also when stepping through the available steps of the wizard without effecting any changes, there are 2 validation steps where all preceding information is checked. These validation steps will check the following for all [[Network_settings#Active|active network types]]:
* There is a root node
* There is a root node
* All net lines are connected directly or indirectly to the root node
* All net lines are connected directly or indirectly to the root node
Line 45: Line 60:
* All net nodes with only 1 net line connected to them have a net load connected to them
* All net nodes with only 1 net line connected to them have a net load connected to them
* All net nodes with a net load connected to them only have 1 net line connected to them
* All net nodes with a net load connected to them only have 1 net line connected to them
* There are no cycles in the network (except for the GAS network type)
<!--* There are no cycles in the network (except for the GAS network type)-->
* All net loads are part of a cluster
* All net loads are part of a cluster


===Net validation===
====Net validation====
The net validation panel will check the following for a given network type:
The net validation panel will check the following for a given network type:
* There is a root node
* There is a root node
Line 58: Line 73:
<!--* All net loads are part of a cluster-->
<!--* All net loads are part of a cluster-->
You will also be able to "highlight" the network. This will highlight all segments of the network that are connected to the root node. All sections of the network that aren't connected in any way to the root node are not connected. This allows you to find small fractures which disconnect sections of the network.
You will also be able to "highlight" the network. This will highlight all segments of the network that are connected to the root node. All sections of the network that aren't connected in any way to the root node are not connected. This allows you to find small fractures which disconnect sections of the network.
{{Template:Editor current situation nav}}

Revision as of 15:47, 27 February 2020

Template:Learned

What is a network

A network is broadly defined as an interconnected system of things. More specifically, networks used here are transport and distribution networks. These are systems composed of interconnected points of supply and demand for specific resources, and the routes connecting them.

How networks relate to the Tygron Platform

In the Tygron Platform, it is possible to add network information to a project.

Network structure

Networks are not themselves an individual component in a project, but are composed of multiple constituent components.

Network type

Each network is related to a predefined resource type. This is known as the network type. The network then is the system through which that resource travels from elements of supply to elements of demand. Each network of a separate type is a separate entity, and networks of different types do not affect each other. The following network types are currently available:

  • ELECTRICITY
  • GAS
  • HEAT
  • INTERNET

Network components

Networks in the Tygron Platform consist first and foremost out of net lines and net nodes. The net lines are the principle element in this structure. The two ends of net lines are defined by net nodes. Each net node has at least one net line connected to it, but any arbitrary number of net lines can start or end at a node. The collection of net lines and net nodes between two arbitrary net nodes is called a path.

Networks also have net loads, which are a definition of supply and demand. These net loads are linked to net nodes, to indicate the supply and demand on that node. A net load is a geographical element, which should be connected to a net node, with data concerning the amount of supply or demand that net node represents. Not every net node needs to have a net load connected to it. However, net loads are only relevant and valid when they are connected to a net node.

Lastly, clusters are also used in conjunction with networks. Clusters group together net loads, and serve as an intermediary to use queries on the loads of networks, or to add panels to the network for reading out information and controlling the network. Clusters are not formally an element of the network. Their existence (or lack thereof) does not inherently influence the validity, functioning, or meaning of the network.

Network settings

There are a number of settings available with which to tweak how networks functions in your project. For more information on the settings available, see Network settings.

Restrictions on networks

  • Networks cannot contain any cycles. All networks should be defined as a tree. If the network is not structured as a tree, network generation and other calculations may have unexpected results.
  • A net node can be connected to 1, 2, or more net lines, except when that node is a load node. In that case, a net node can only be connected to exactly 1 net line.
  • Behavior for networks linked with buildings which are altered during a session are undefined. When using network functionality, the buildings linked to by the network should not be demolished, upgraded, sold to other stakeholders, or otherwise changed.

Adding and editing networks

Because networks are complex elements in a project, there are multiple topics devoted to creating and verifying your network.

Ways of creating a network

There are multiple ways to add a network to a project. Depending on the availability of data and the prospective complexity of the network some methods may be more appropriate.

Generating

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.

Editor → Current Situation (Ribbon tab) → Networks (Ribbon bar) → Network wizard (Dropdown)

Importing Data

This section is a stub.

Manually

Although not very practical, it is possible to create or edit networks manually, by placing net lines and net loads in the world piece by piece.

Checking for errors

When there is doubt on whether the network has been created correctly, there are options to have the Tygron Platform check for issues automatically.

Network wizard

When creating or importing network data using the net wizard, but also when stepping through the available steps of the wizard without effecting any changes, there are 2 validation steps where all preceding information is checked. These validation steps will check the following for all active network types:

  • There is a root node
  • All net lines are connected directly or indirectly to the root node
  • All net loads are connected via paths composed of net lines to the root note
  • All net nodes with only 1 net line connected to them have a net load connected to them
  • All net nodes with a net load connected to them only have 1 net line connected to them
  • All net loads are part of a cluster

Net validation

The net validation panel will check the following for a given network type:

  • There is a root node
  • All net lines are connected directly or indirectly to the root node
  • All net nodes with only 1 net line connected to them have a net load connected to them
  • All net nodes with a net load connected to them only have 1 net line connected to them

You will also be able to "highlight" the network. This will highlight all segments of the network that are connected to the root node. All sections of the network that aren't connected in any way to the root node are not connected. This allows you to find small fractures which disconnect sections of the network.