GPKG Time Series Format Specification - Revision history

Emilie Nielsen at 01:41, 16 December 2024

2024-12-16T01:41:02Z

← Older revision		Revision as of 11:41, 16 December 2024
Line 1:		Line 1:
	The below sections describe the TUFLOW GPKG time series format specification. The specification is build ontop of the <b><u>[https://www.geopackage.org/spec120/index.html GPKG v1.2 Specification]</u></b> with two additional required tables. The additional tables and details of the GIS layers are described below with examples. The examples are based a the 1D/2D linked TUFLOW-SWMM example model based on TUFLOW's ~~module 6~~ tutorial model - <b>M06_5m_003.tcf</b>.		The below sections describe the TUFLOW GPKG time series format specification. The specification is build ontop of the <b><u>[https://www.geopackage.org/spec120/index.html GPKG v1.2 Specification]</u></b> with two additional required tables. The additional tables and details of the GIS layers are described below with examples. The examples are based a the 1D/2D linked TUFLOW-SWMM example model based on TUFLOW's tutorial model 6 - <b>M06_5m_003.tcf</b>.

	=== TUFLOW Time Series Version ===		=== TUFLOW Time Series Version ===

Emilie Nielsen at 02:04, 11 December 2024

2024-12-11T02:04:32Z

← Older revision		Revision as of 12:04, 11 December 2024
Line 1:		Line 1:
	The below ~~section~~ describe the TUFLOW GPKG time series format specification. The specification is build ontop of the <b><u>[https://www.geopackage.org/spec120/index.html GPKG v1.2 Specification]</u></b> with two additional required tables. The additional tables and details of the GIS layers are ~~descibed~~ below with examples. The examples are based a the 1D/2D linked TUFLOW-SWMM example model based on TUFLOW's module 6 tutorial model - <b>M06_5m_003.tcf</b>.		The below sections describe the TUFLOW GPKG time series format specification. The specification is build ontop of the <b><u>[https://www.geopackage.org/spec120/index.html GPKG v1.2 Specification]</u></b> with two additional required tables. The additional tables and details of the GIS layers are described below with examples. The examples are based a the 1D/2D linked TUFLOW-SWMM example model based on TUFLOW's module 6 tutorial model - <b>M06_5m_003.tcf</b>.

	=== TUFLOW Time Series Version ===		=== TUFLOW Time Series Version ===

Ellis Symons at 10:49, 10 November 2023

2023-11-10T10:49:34Z

← Older revision		Revision as of 20:49, 10 November 2023
Line 126:		Line 126:
	\|-		\|-
	\|}		\|}

			<br><br>
			{{Tips Navigation
			\|uplink=[[TUFLOW_Viewer#GPKG_Time_Series_Format\| Back to TUFLOW Viewer Main Page]]
			}}

Ellis Symons at 10:47, 10 November 2023

2023-11-10T10:47:36Z

← Older revision		Revision as of 20:47, 10 November 2023
Line 1:		Line 1:
	The below section describe the TUFLOW GPKG time series format specification. The specification ~~sits~~ ontop of the <b><u>[https://www.geopackage.org/spec120/index.html GPKG v1.2 Specification]</u></b> with two additional required tables. The additional tables and details of the GIS layers are descibed below with examples. The examples are based a the 1D/2D linked TUFLOW-SWMM example model based on TUFLOW's module 6 tutorial model - <b>M06_5m_003.tcf</b>.		The below section describe the TUFLOW GPKG time series format specification. The specification is build ontop of the <b><u>[https://www.geopackage.org/spec120/index.html GPKG v1.2 Specification]</u></b> with two additional required tables. The additional tables and details of the GIS layers are descibed below with examples. The examples are based a the 1D/2D linked TUFLOW-SWMM example model based on TUFLOW's module 6 tutorial model - <b>M06_5m_003.tcf</b>.

	=== TUFLOW Time Series Version ===		=== TUFLOW Time Series Version ===

Ellis Symons at 10:47, 10 November 2023

2023-11-10T10:47:13Z

← Older revision		Revision as of 20:47, 10 November 2023
Line 93:		Line 93:
	\|}		\|}
	<Br>		<Br>
	The GIS layer should contain a feature for each applicable element and timestep i.e. the same pipe may be referenced 10 times if there are 10 output timesteps. The order be ascending based on the output time.<Br>		The GIS layer should contain a feature for each applicable element and timestep i.e. the same pipe may be referenced 10 times if there are 10 output timesteps. The order should be ascending based on the output time.<Br>
	<b>Example <code>M06_5m_003_swmm_ts_L</code> with three output timesteps and three culverts</b><Br>		<b>Example <code>M06_5m_003_swmm_ts_L</code> with three output timesteps and three culverts</b><Br>
	{\| class="wikitable" style="width:70%"		{\| class="wikitable" style="width:70%"

Ellis Symons at 10:46, 10 November 2023

2023-11-10T10:46:50Z

@@ Line 48: / Line 48: @@
 ! style="background-color:#005581; font-weight:bold; color:white;" width=5%| Series_units
 |-
-|1||M06_5m_003_swmm_ts_P||22||hours since 2020-01-01 00:00:00||0.083333||Depth||Depth||m
+|1||M06_5m_003_swmm_ts_P||22||hours since 2020-01-01 00:00:00||1.0||Depth||Depth||m
 |-
-|2||M06_5m_003_swmm_ts_P||22||hours since 2020-01-01 00:00:00||0.083333||Water Level||Water Level||m
+|2||M06_5m_003_swmm_ts_P||22||hours since 2020-01-01 00:00:00||1.0||Water Level||Water Level||m
 |-
-|3||M06_5m_003_swmm_ts_P||22||hours since 2020-01-01 00:00:00||0.083333||Storage Volume||Storage Volume||m3
+|3||M06_5m_003_swmm_ts_P||22||hours since 2020-01-01 00:00:00||1.0||Storage Volume||Storage Volume||m3
 |-
-|4||M06_5m_003_swmm_ts_L||18||hours since 2020-01-01 00:00:00||0.083333||Flow||Flow||cms
+|4||M06_5m_003_swmm_ts_L||18||hours since 2020-01-01 00:00:00||1.0||Flow||Flow||cms
 |-
-|5||M06_5m_003_swmm_ts_L||18||hours since 2020-01-01 00:00:00||0.083333||Velocity||Velocity||m/s
+|5||M06_5m_003_swmm_ts_L||18||hours since 2020-01-01 00:00:00||1.0||Velocity||Velocity||m/s
 |-
 |}
@@ Line 90: / Line 90: @@
 |-
 |Velocity||FLOAT||Result velocity
 |-
 |}

Ellis Symons at 10:24, 10 November 2023

2023-11-10T10:24:25Z

← Older revision		Revision as of 20:24, 10 November 2023
Line 37:		Line 37:
	\|}		\|}
	<br>		<br>
	<b>Example</b><br>		<b>Example <code>Timeseries_info</code></b><br>
	{\| class="wikitable" style="width:70%"		{\| class="wikitable" style="width:70%"
	! style="background-color:#005581; font-weight:bold; color:white;" width=5%\| Row		! style="background-color:#005581; font-weight:bold; color:white;" width=5%\| Row
Line 56:		Line 56:
	\|4\|\|M06_5m_003_swmm_ts_L\|\|18\|\|hours since 2020-01-01 00:00:00\|\|0.083333\|\|Flow\|\|Flow\|\|cms		\|4\|\|M06_5m_003_swmm_ts_L\|\|18\|\|hours since 2020-01-01 00:00:00\|\|0.083333\|\|Flow\|\|Flow\|\|cms
	\|-		\|-
	\|4\|\|M06_5m_003_swmm_ts_L\|\|18\|\|hours since 2020-01-01 00:00:00\|\|0.083333\|\|Velocity\|\|Velocity\|\|m/s		\|5\|\|M06_5m_003_swmm_ts_L\|\|18\|\|hours since 2020-01-01 00:00:00\|\|0.083333\|\|Velocity\|\|Velocity\|\|m/s
	\|-		\|-
	\|}		\|}

Ellis Symons at 10:23, 10 November 2023

2023-11-10T10:23:43Z

@@ Line 34: / Line 34: @@
 |-
 |Series_units||TEXT||Result type units
 |-
 |}

Ellis Symons at 10:13, 10 November 2023

2023-11-10T10:13:33Z

← Older revision		Revision as of 20:13, 10 November 2023
Line 1:		Line 1:
	The below section ~~lists~~ the TUFLOW GPKG time series format specification. The specification sits ontop of the <b><u>[https://www.geopackage.org/spec120/index.html GPKG v1.2 Specification]</u></b> with two additional required tables. The ~~below~~ ~~lists~~ ~~the~~ details of the ~~additional~~ ~~tables~~ with examples. The examples are based a the 1D/2D linked TUFLOW-SWMM example model based on TUFLOW's module 6 tutorial model - <b>M06_5m_003.tcf</b>.		The below section describe the TUFLOW GPKG time series format specification. The specification sits ontop of the <b><u>[https://www.geopackage.org/spec120/index.html GPKG v1.2 Specification]</u></b> with two additional required tables. The additional tables and details of the GIS layers are descibed below with examples. The examples are based a the 1D/2D linked TUFLOW-SWMM example model based on TUFLOW's module 6 tutorial model - <b>M06_5m_003.tcf</b>.

	=== TUFLOW Time Series Version ===		=== TUFLOW Time Series Version ===
Line 62:		Line 62:
	\|Datetime\|\|DATETIME\|\|Output time in datetime		\|Datetime\|\|DATETIME\|\|Output time in datetime
	\|-		\|-
	\|colspan="3"\|...[column for each result type for that given geometry type - examples below]		\|colspan="3"\|...[column for each result type for that given geometry type as listed in <code>Timeseries_info</code>- examples below]
	\|-		\|-
	\|Flow\|\|FLOAT\|\|Result flow		\|Flow\|\|FLOAT\|\|Result flow

Ellis Symons at 16:58, 9 November 2023

2023-11-09T16:58:51Z

← Older revision		Revision as of 02:58, 10 November 2023
Line 2:		Line 2:

	=== TUFLOW Time Series Version ===		=== TUFLOW Time Series Version ===
	An additional table called <Code>TUFLOW_timeseries_version</code> should be present in the GPKG ~~with~~ the following columns:<br>		An additional table called <Code>TUFLOW_timeseries_version</code> should be present in the GPKG. This table contains the version number of the TUFLOW GPKG time series format and should be set to <code>1.0.0</code>. The table should have the following columns:<br>
	{\| class="wikitable" style="width:40%"		{\| class="wikitable" style="width:40%"
	! style="background-color:#005581; font-weight:bold; color:white;" width=20%\| Column Name		! style="background-color:#005581; font-weight:bold; color:white;" width=20%\| Column Name
Line 8:		Line 8:
	! style="background-color:#005581; font-weight:bold; color:white;" width=60%\| Description		! style="background-color:#005581; font-weight:bold; color:white;" width=60%\| Description
	\|-		\|-
	\|Version\|\|TEXT\|\|Major.Minor.Patch version number ~~(e.g. 1.0.0)~~		\|Version\|\|TEXT\|\|Major.Minor.Patch version number
	\|-		\|-
	\|}		\|}

	=== Time Series Info ===		=== Time Series Info ===
			An additional table called <code>Timeseries_info</code> should be present in the GPKG. The purpose of this table is to list the available result types and relevant information for each type. The table should have the following columns:<br>
	...
			{\| class="wikitable" style="width:50%"
			! style="background-color:#005581; font-weight:bold; color:white;" width=15%\| Column Name
			! style="background-color:#005581; font-weight:bold; color:white;" width=15%\| Type
			! style="background-color:#005581; font-weight:bold; color:white;" width=70%\| Description
			\|-
			\|row\|\|INTEGER\|\|Primary key
			\|-
			\|Table_name\|\|TEXT\|\|Reference to the GIS table that the result sits within
			\|-
			\|Count\|\|INTEGER\|\|Number of unique elements
			\|-
			\|Reference_time\|\|TEXT\|\|Reference time in the form of: <code>[UNITS] since YYYY-MM-DD hh:mm:ss</code>
			\|-
			\|dt\|\|FLOAT\|\|Output timestep (units defined in <code>Reference_time</code>)
			\|-
			\|Column_name\|\|TEXT\|\|Name of the column in the GIS table containing the result
			\|-
			\|Series_name\|\|TEXT\|\|Name of the result type
			\|-
			\|Series_units\|\|TEXT\|\|Result type units
			\|-
			\|}

	===GIS Layers===		===GIS Layers===
Line 19:		Line 41:
	<br>		<br>
	The column names of the GPKG layers should follow the convention below:<br>		The column names of the GPKG layers should follow the convention below:<br>
	{\| class="wikitable" style="width:40%"		{\| class="wikitable" style="width:50%"
	! style="background-color:#005581; font-weight:bold; color:white;" width=20%\| Column Name		! style="background-color:#005581; font-weight:bold; color:white;" width=20%\| Column Name
	! style="background-color:#005581; font-weight:bold; color:white;" width=20%\| Type		! style="background-color:#005581; font-weight:bold; color:white;" width=20%\| Type
Line 36:		Line 58:
	\|TimeId\|\|INTEGER\|\|Unique id for each timestep		\|TimeId\|\|INTEGER\|\|Unique id for each timestep
	\|-		\|-
	\|~~Time_hours~~\|\|FLOAT\|\|Output time in ~~hours~~		\|Time_relative\|\|FLOAT\|\|Output relative time (reference time and units in <code>Timeseries_info</code>)
	\|-		\|-
	\|Datetime\|\|DATETIME\|\|Output time in datetime		\|Datetime\|\|DATETIME\|\|Output time in datetime