Networks tutorial - Revision history

Frank@tygron.nl at 14:30, 30 January 2023

2023-01-30T14:30:11Z

Maxim@tygron.com at 15:17, 7 October 2022

2022-10-07T15:17:59Z

← Older revision		Revision as of 15:17, 7 October 2022
Line 15:		Line 15:

	These datatypes form the actual network. However, when discussing networks in the {{software}}, the following datatypes are of importance when dealing with networks:		These datatypes form the actual network. However, when discussing networks in the {{software}}, the following datatypes are of importance when dealing with networks:
	* [[Net Function]]s: Just like [[~~construction~~]]s being defined by a function definition, net lines have a net function definition as well. Any values not defined specifically for an individual net line, are derived from the net function definition.		* [[Net Function]]s: Just like [[building]]s being defined by a function definition, net lines have a net function definition as well. Any values not defined specifically for an individual net line, are derived from the net function definition.
	* [[Net Cluster]]s: Net loads can be grouped together into clusters, to make interacting with the net loads more manageable for end users. Clusters are not directly part of the network but serve as an interface between the network and end-user methods to interact with the 3D world.		* [[Net Cluster]]s: Net loads can be grouped together into clusters, to make interacting with the net loads more manageable for end users. Clusters are not directly part of the network but serve as an interface between the network and end-user methods to interact with the 3D world.
	{{page_break}}		{{page_break}}

Maxim@tygron.com at 15:56, 5 October 2022

2022-10-05T15:56:40Z

← Older revision		Revision as of 15:56, 5 October 2022
Line 1:		Line 1:
	~~{{learned\|what a network is\|how the parts of a network function\|how to manually create a network\|how to automatically generate a network\|how to interact with a network}}~~
	{{tutorial prerequisites		{{tutorial prerequisites
	\|tutorial=This tutorial relies on base knowledge about the editor interface.		\|tutorial=This tutorial relies on base knowledge about the editor interface.

Rudolf@tygron.nl: /* Network generation */

2020-02-10T09:24:15Z

Network generation

← Older revision		Revision as of 09:24, 10 February 2020
Line 211:		Line 211:
	Now that the clusters have been generated, the potentially hundreds or thousands of net loads in the project area have been grouped in at most a few dozen clusters. These collections of net loads allow a large number of net loads to be controlled en masse. The wizard will offer to generate a set of standardized [[interaction panel\|panel]]s to allow this control.		Now that the clusters have been generated, the potentially hundreds or thousands of net loads in the project area have been grouped in at most a few dozen clusters. These collections of net loads allow a large number of net loads to be controlled en masse. The wizard will offer to generate a set of standardized [[interaction panel\|panel]]s to allow this control.

	Opt to generate Template Excel ~~Panels~~.		Opt to generate Template Excel [[Panel]]s.
	[[File:network-wizard-panels.jpg\|350px\|frame\|center\|Opt to generate panels to control the clusters.]]		[[File:network-wizard-panels.jpg\|350px\|frame\|center\|Opt to generate panels to control the clusters.]]

Line 235:		Line 235:
	{{page_break}}		{{page_break}}

	Click on it to open the panel related to the cluster.		Click on it to open the [[panel]] related to the cluster.
	[[File:network-popup-panel.jpg\|350px\|frame\|center\|The panel to control the cluster.]]		[[File:network-popup-panel.jpg\|350px\|frame\|center\|The panel to control the cluster.]]
	It will display some basic information on the connections which are grouped together in this cluster.		It will display some basic information on the connections which are grouped together in this cluster.

Rudolf@tygron.nl at 09:15, 10 February 2020

2020-02-10T09:15:06Z

← Older revision		Revision as of 09:15, 10 February 2020
Line 155:		Line 155:
	{{page_break}}		{{page_break}}

	When prompted, select all ~~stakeholders~~.		When prompted, select all [[stakeholder]]s.
	[[File:network-wizard-network-stakeholders.jpg\|350px\|frame\|center\|Select all stakeholders.]]		[[File:network-wizard-network-stakeholders.jpg\|350px\|frame\|center\|Select all stakeholders.]]

Line 192:		Line 192:
	[[File:network-wizard-clusters-neighborhoods.jpg\|350px\|frame\|center\|Select all neighborhoods. The listed neighborhoods are those with net loads.]]		[[File:network-wizard-clusters-neighborhoods.jpg\|350px\|frame\|center\|Select all neighborhoods. The listed neighborhoods are those with net loads.]]

	When prompted, select all ~~stakeholders~~.		When prompted, select all [[stakeholder]]s.
	[[File:network-wizard-clusters-stakeholders.jpg\|350px\|frame\|center\|Select all stakeholders.]]		[[File:network-wizard-clusters-stakeholders.jpg\|350px\|frame\|center\|Select all stakeholders.]]
	{{page_break}}		{{page_break}}
Line 225:		Line 225:
	[[File:network-popup-clusters.jpg\|350px\|frame\|center\|Symbols in the 3D world indicating the presence of clustered net loads.]]		[[File:network-popup-clusters.jpg\|350px\|frame\|center\|Symbols in the 3D world indicating the presence of clustered net loads.]]

	These mark the locations of clusters of net loads. They consist of one or more colored figures. The quantity indicates whether the cluster should be considered a clustering of individual connections, or a single connection serving multiple addresses. The color indicates which stakeholder owns the cluster.		These mark the locations of clusters of net loads. They consist of one or more colored figures. The quantity indicates whether the cluster should be considered a clustering of individual connections, or a single connection serving multiple addresses. The color indicates which [[stakeholder]] owns the cluster.
	{{page_break}}		{{page_break}}

Rudolf@tygron.nl at 09:13, 10 February 2020

2020-02-10T09:13:58Z

← Older revision		Revision as of 09:13, 10 February 2020
Line 209:		Line 209:
	[[File:network-wizard-clusters-validation.jpg\|350px\|frame\|center\|The wizard will validate that the generated clusters provide full coverage of all net loads.]]		[[File:network-wizard-clusters-validation.jpg\|350px\|frame\|center\|The wizard will validate that the generated clusters provide full coverage of all net loads.]]

	Now that the clusters have been generated, the potentially hundreds or thousands of net loads in the project area have been grouped in at most a few dozen clusters. These collections of net loads allow a large number of net loads to be controlled en masse. The wizard will offer to generate a set of standardized interaction ~~panels~~ to allow this control.		Now that the clusters have been generated, the potentially hundreds or thousands of net loads in the project area have been grouped in at most a few dozen clusters. These collections of net loads allow a large number of net loads to be controlled en masse. The wizard will offer to generate a set of standardized [[interaction panel\|panel]]s to allow this control.

	Opt to generate Template Excel Panels.		Opt to generate Template Excel Panels.

Rudolf@tygron.nl at 09:13, 10 February 2020

2020-02-10T09:13:20Z

← Older revision		Revision as of 09:13, 10 February 2020
Line 151:		Line 151:
	[[File:network-wizard-network-opt-generate.jpg\|350px\|frame\|center\|Choose to generate a new collection of net loads.]]		[[File:network-wizard-network-opt-generate.jpg\|350px\|frame\|center\|Choose to generate a new collection of net loads.]]

	When prompted, select a neighborhood in your project with residential buildings.		When prompted, select a [[neighborhood]] in your project with residential buildings.
	[[File:network-wizard-network-neighborhoods.jpg\|350px\|frame\|center\|Select the residential projects in your neighborhood.]]		[[File:network-wizard-network-neighborhoods.jpg\|350px\|frame\|center\|Select the residential projects in your neighborhood.]]
	{{page_break}}		{{page_break}}

Rudolf@tygron.nl at 09:08, 10 February 2020

2020-02-10T09:08:10Z

← Older revision		Revision as of 09:08, 10 February 2020
Line 12:		Line 12:
	Networks are composed of a number of datatypes:		Networks are composed of a number of datatypes:
	* [[Net Node]]s: These form the vertices of the network graph; the individual points which can be connected by lines. Net nodes cannot be directly edited as a discrete datatype as such, but are a relevant datatype to be aware of when working with networks.		* [[Net Node]]s: These form the vertices of the network graph; the individual points which can be connected by lines. Net nodes cannot be directly edited as a discrete datatype as such, but are a relevant datatype to be aware of when working with networks.
	* [[Net ~~Lines~~]]: These form the edges of the network; the connections between the points. Net lines are defined by the net nodes they connect, and form the connections between one point on the network and another.		* [[Net Line]]s: These form the edges of the network; the connections between the points. Net lines are defined by the net nodes they connect, and form the connections between one point on the network and another.
	* [[Net ~~Loads~~]]: These form a collection of properties for end-points on the network, and must be connected to any net node which forms an end-point on the network. This means that any net node which has only 1 net line connecting to it should have a net load connected to it. The net load defines the amount of the specified resource the endpoint produces or consumes.		* [[Net Load]]s: These form a collection of properties for end-points on the network, and must be connected to any net node which forms an end-point on the network. This means that any net node which has only 1 net line connecting to it should have a net load connected to it. The net load defines the amount of the specified resource the endpoint produces or consumes.

	These datatypes form the actual network. However, when discussing networks in the {{software}}, the following datatypes are of importance when dealing with networks:		These datatypes form the actual network. However, when discussing networks in the {{software}}, the following datatypes are of importance when dealing with networks:

Rudolf@tygron.nl at 09:00, 10 February 2020

2020-02-10T09:00:23Z

← Older revision		Revision as of 09:00, 10 February 2020
Line 11:		Line 11:

	Networks are composed of a number of datatypes:		Networks are composed of a number of datatypes:
	* Net ~~Nodes~~: These form the vertices of the network graph; the individual points which can be connected by lines. Net nodes cannot be directly edited as a discrete datatype as such, but are a relevant datatype to be aware of when working with networks.		* [[Net Node]]s: These form the vertices of the network graph; the individual points which can be connected by lines. Net nodes cannot be directly edited as a discrete datatype as such, but are a relevant datatype to be aware of when working with networks.
	* Net Lines: These form the edges of the network; the connections between the points. Net lines are defined by the net nodes they connect, and form the connections between one point on the network and another.		* [[Net Lines]]: These form the edges of the network; the connections between the points. Net lines are defined by the net nodes they connect, and form the connections between one point on the network and another.
	* Net Loads: These form a collection of properties for end-points on the network, and must be connected to any net node which forms an end-point on the network. This means that any net node which has only 1 net line connecting to it should have a net load connected to it. The net load defines the amount of the specified resource the endpoint produces or consumes.		* [[Net Loads]]: These form a collection of properties for end-points on the network, and must be connected to any net node which forms an end-point on the network. This means that any net node which has only 1 net line connecting to it should have a net load connected to it. The net load defines the amount of the specified resource the endpoint produces or consumes.

	These datatypes form the actual network. However, when discussing networks in the {{software}}, the following datatypes are of importance when dealing with networks:		These datatypes form the actual network. However, when discussing networks in the {{software}}, the following datatypes are of importance when dealing with networks:
	* Net ~~Functions~~: Just like ~~constructions~~ being defined by a function definition, net lines have a net function definition as well. Any values not defined specifically for an individual net line, are derived from the net function definition.		* [[Net Function]]s: Just like [[construction]]s being defined by a function definition, net lines have a net function definition as well. Any values not defined specifically for an individual net line, are derived from the net function definition.
	* Net ~~Clusters~~: Net loads can be grouped together into clusters, to make interacting with the net loads more manageable for end users. Clusters are not directly part of the network but serve as an interface between the network and end-user methods to interact with the 3D world.		* [[Net Cluster]]s: Net loads can be grouped together into clusters, to make interacting with the net loads more manageable for end users. Clusters are not directly part of the network but serve as an interface between the network and end-user methods to interact with the 3D world.
	{{page_break}}		{{page_break}}

Rudolf@tygron.nl: /* Network calculations */

2020-01-06T13:03:30Z

Network calculations

← Older revision		Revision as of 13:03, 6 January 2020
Line 127:		Line 127:
	{{header\|level=3\|color=#c45911\|Assignments}}		{{header\|level=3\|color=#c45911\|Assignments}}
	These assignments guide you to further explore the basic calculation functionality already exposed with a basic network.		These assignments guide you to further explore the basic calculation functionality already exposed with a basic network.
	# Increase the amount of electricity the consumers require, so that the sum of their consumption exceeds that of the producer. Inspect the net lines during a testrun to see the consequences. Increased consumption should lead to greater FLOW values in the net lines attached to them.		# Increase the amount of electricity the consumers require, so that the sum of their consumption exceeds that of the producer. Inspect the net lines during a testrun to see the consequences. Increased consumption should lead to greater FLOW values in the net lines attached to them. Stop the testrun afterwards.
	# Add an additional line to the network branching off somewhere along the middle, which then branches off further into two endpoints. Add an additional consumer to one endpoint, and an additional producer to the other endpoint. Inspect the net lines during a testrun to see the consequences. The FLOW in the net lines should take into account where (additional) production is present.		# Add an additional line to the network branching off somewhere along the middle, which then branches off further into two endpoints. Add an additional consumer to one endpoint, and an additional producer to the other endpoint. Inspect the net lines during a testrun to see the consequences. The FLOW in the net lines should take into account where (additional) production is present. Stop the testrun afterwards.
	# Set the timestate of one or two net loads to "NOTHING". Inspect the net lines during a testrun to see the consequences.		# Set the timestate of one or two net loads to "NOTHING". Inspect the net lines during a testrun to see the consequences. Stop the testrun afterwards.
	{{page_break}}		{{page_break}}

← Older revision		Revision as of 14:30, 30 January 2023
Line 7:		Line 7:
	}}		}}
	==Introduction to networks==		==Introduction to networks==
	Networks are a separate data layer in a ~~3D world~~, intended to model actual resource transport networks, such as for gas, heat, and internet. They are modeled as a mathematical graph consisting of vertices (points) and edges (lines connecting the points).		Networks are a separate data layer in a [[project]], intended to model actual resource transport networks, such as for gas, heat, and internet. They are modeled as a mathematical graph consisting of vertices (points) and edges (lines connecting the points).

	Networks are composed of a number of datatypes:		Networks are composed of a number of datatypes:
Line 16:		Line 16:
	These datatypes form the actual network. However, when discussing networks in the {{software}}, the following datatypes are of importance when dealing with networks:		These datatypes form the actual network. However, when discussing networks in the {{software}}, the following datatypes are of importance when dealing with networks:
	* [[Net Function]]s: Just like [[building]]s being defined by a function definition, net lines have a net function definition as well. Any values not defined specifically for an individual net line, are derived from the net function definition.		* [[Net Function]]s: Just like [[building]]s being defined by a function definition, net lines have a net function definition as well. Any values not defined specifically for an individual net line, are derived from the net function definition.
	* [[Net Cluster]]s: Net loads can be grouped together into clusters, to make interacting with the net loads more manageable for end users. Clusters are not directly part of the network but serve as an interface between the network and end-user ~~methods to interact with~~ the 3D ~~world~~.		* [[Net Cluster]]s: Net loads can be grouped together into clusters, to make interacting with the net loads more manageable for end users. Clusters are not directly part of the network but serve as an interface between the network and end-user, for example by visualizing them as [[popup]]s in the [[3D Visualization]].
	{{page_break}}		{{page_break}}

Line 39:		Line 39:
	{{editor location\|net edit}}		{{editor location\|net edit}}
	[[File:network-bottom-edit-add.jpg\|350px\|frame\|center\|The network editing options in the bottom panel.]]		[[File:network-bottom-edit-add.jpg\|350px\|frame\|center\|The network editing options in the bottom panel.]]
	Click in a location in the 3D ~~world~~ to set the first net node location. Click in another location to set the second net node location. You will see a net line appear in the 3D ~~world~~.		Click in a location in the [[3D Visualization]] to set the first net node location. Click in another location to set the second net node location. You will see a net line appear in the 3D Visualization.
	[[File:network-draw1.jpg\|350px\|frame\|center\|The first drawn net line.]]		[[File:network-draw1.jpg\|350px\|frame\|center\|The first drawn net line.]]
	{{page_break}}		{{page_break}}
Line 164:		Line 164:
	[[File:network-wizard-network-function.jpg\|350px\|frame\|center\|Select the default Electricity Line function.]]		[[File:network-wizard-network-function.jpg\|350px\|frame\|center\|Select the default Electricity Line function.]]

	You will be prompted to place the initial root of the network somewhere in the ~~3D world~~. Opt to draw the root load in the map (and to switch to the 3D ~~View~~ to perform the action).		You will be prompted to place the initial root of the network somewhere in the project area. Opt to draw the root load in the map (and to switch to the [[3D Visualization]] to perform the action).
	[[File:network-wizard-network-opt-root.jpg\|350px\|frame\|center\|Opt to draw the root in the ~~3D world~~, and then choose to go to the 3D ~~world~~ to do so.]]		[[File:network-wizard-network-opt-root.jpg\|350px\|frame\|center\|Opt to draw the root in the project, and then choose to go to the 3D Visualization to do so.]]

	Click in a location in the 3D ~~world~~ to place the root load there. Preferably, place it near the edge of the residential neighborhood.		Click in a location in the 3D Visualization to place the root load there. Preferably, place it near the edge of the residential neighborhood.
	[[File:network-wizard-network-root.jpg\|350px\|frame\|center\|The root placed in the ~~3D world~~ by clicking there.]]		[[File:network-wizard-network-root.jpg\|350px\|frame\|center\|The root placed in the project by clicking there in the 3D Visualization.]]
	{{page_break}}		{{page_break}}

Line 181:		Line 181:
	[[File:network-wizard-network-validation.jpg\|350px\|frame\|center\|The wizard will validate that the generated network has no errors.]]		[[File:network-wizard-network-validation.jpg\|350px\|frame\|center\|The wizard will validate that the generated network has no errors.]]

	This concludes the generation of the network itself. If you minimize (not close) the wizard window, you will be able to see the network in the 3D ~~world~~.		This concludes the generation of the network itself. If you minimize (not close) the wizard window, you will be able to see the network in the [[3D Visualization]].
	[[File:network-wizard-network-3D.jpg\|350px\|frame\|center\|Finish the network generation step of the wizard.]]		[[File:network-wizard-network-3D.jpg\|350px\|frame\|center\|Finish the network generation step of the wizard.]]
	{{page_break}}		{{page_break}}
Line 216:		Line 216:
	{{page_break}}		{{page_break}}

	Continue through the remaining steps of the wizard and complete it. The wizard window will close and you will be returned to the 3D ~~world~~.		Continue through the remaining steps of the wizard and complete it. The wizard window will close and you will be returned to the 3D Visualization.
	[[File:network-wizard-finished.jpg\|350px\|frame\|center\|The wizard is now finished.]]		[[File:network-wizard-finished.jpg\|350px\|frame\|center\|The wizard is now finished.]]

	Feel free to look around the 3D ~~world~~ and see how the network has been generated.		Feel free to look around using the 3D Visualization and see how the network has been generated.

	Take note of the cluster symbols which have appeared.		Take note of the cluster symbols which have appeared.
	[[File:network-popup-clusters.jpg\|350px\|frame\|center\|Symbols in the 3D ~~world~~ indicating the presence of clustered net loads.]]		[[File:network-popup-clusters.jpg\|350px\|frame\|center\|Symbols in the 3D Visualization indicating the presence of clustered net loads.]]

	These mark the locations of clusters of net loads. They consist of one or more colored figures. The quantity indicates whether the cluster should be considered a clustering of individual connections, or a single connection serving multiple addresses. The color indicates which [[stakeholder]] owns the cluster.		These mark the locations of clusters of net loads. They consist of one or more colored figures. The quantity indicates whether the cluster should be considered a clustering of individual connections, or a single connection serving multiple addresses. The color indicates which [[stakeholder]] owns the cluster.
Line 292:		Line 292:
	Select "Apply Template", and the necessary instances of this panel will be created.		Select "Apply Template", and the necessary instances of this panel will be created.

	Note that no new popups have appeared in the 3D ~~world~~. For the net owner the popups are configured such that they will only appear when the net owner has a decision to make. The owner of the cluster still has to make the first connection before the popup will appear.		Note that no new popups have appeared in the 3D Visualization. For the net owner the popups are configured such that they will only appear when the net owner has a decision to make. The owner of the cluster still has to make the first connection before the popup will appear.

	Switch back to the stakeholder who owns the cluster, open the popup, and click on "Connect". Then wait for the testrun to start and the connections to be made.		Switch back to the stakeholder who owns the cluster, open the popup, and click on "Connect". Then wait for the testrun to start and the connections to be made.