TUFLOW NetCDF Cell Centre Output Format - Revision history

Emilie Nielsen at 23:52, 22 September 2024

2024-09-22T23:52:47Z

← Older revision		Revision as of 09:52, 23 September 2024
Line 13:		Line 13:
	<font color="blue"><tt>NetCDF Output Format </tt></font> <font color="red"><tt>==</tt></font><tt> {FEWS} \| Generic</tt><br>		<font color="blue"><tt>NetCDF Output Format </tt></font> <font color="red"><tt>==</tt></font><tt> {FEWS} \| Generic</tt><br>
	<br>		<br>
	Please refer to the TUFLOW ~~manual~~ for more details on these commands.		Please refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for more details on these commands.

	==Global Attributes==		==Global Attributes==

Pavlina Monhartova: /* Variables */

2018-11-23T00:00:12Z

Variables

← Older revision		Revision as of 10:00, 23 November 2018
Line 51:		Line 51:
	* Temporal variables		* Temporal variables
	* Non Temporal variables.		* Non Temporal variables.
	For example if the model writes depths ~~our~~ every 10 minutes and tracking maximums is enabled (default) then two depth datasets are written: '''depths''' and '''maximum_depths'''. These are described further below.		For example if the model writes depths out every 10 minutes and tracking maximums is enabled (default) then two depth datasets are written: '''depths''' and '''maximum_depths'''. These are described further below.

Pavlina Monhartova at 23:59, 22 November 2018

2018-11-22T23:59:31Z

← Older revision		Revision as of 09:59, 23 November 2018
Line 22:		Line 22:
	* Comment - A description of the output.		* Comment - A description of the output.
	* NetCDF File Format Version - A unique value for file version, for the 2017 version this is 2.		* NetCDF File Format Version - A unique value for file version, for the 2017 version this is 2.
	* NetCDF Data Type - This is 1 for <u>[[TUFLOW_NetCDF_Raster_Output_Format \| "NC" raster output]]</u> and 2 for ~~<u>[[TUFLOW_NetCDF_Raster_Output_Format~~ \| ~~"NC" raster output]]</u>~~.		* NetCDF Data Type - This is 1 for <u>[[TUFLOW_NetCDF_Raster_Output_Format \| "NC" raster output]]</u> and 2 for cell centered results.
	An example of the '''Global Attributes''' is:		An example of the '''Global Attributes''' is:
	<pre>		<pre>

Pavlina Monhartova: /* Global Attributes */

2018-11-22T23:56:04Z

Global Attributes

← Older revision		Revision as of 09:56, 23 November 2018
Line 22:		Line 22:
	* Comment - A description of the output.		* Comment - A description of the output.
	* NetCDF File Format Version - A unique value for file version, for the 2017 version this is 2.		* NetCDF File Format Version - A unique value for file version, for the 2017 version this is 2.
	* NetCDF Data Type - This is 1 for <u>[[TUFLOW_NetCDF_Raster_Output_Format \| "NC" raster output]]</u> and 2 for <u>[[~~TUFLOW_NetCDF_Cell_Centre_Output_Format~~ \| "NC" ~~cell~~ ~~centered results~~]]</u>.		* NetCDF Data Type - This is 1 for <u>[[TUFLOW_NetCDF_Raster_Output_Format \| "NC" raster output]]</u> and 2 for <u>[[TUFLOW_NetCDF_Raster_Output_Format \| "NC" raster output]]</u>.
	An example of the '''Global Attributes''' is:		An example of the '''Global Attributes''' is:
	<pre>		<pre>

Pavlina Monhartova: /* Global Attributes */

2018-11-22T23:50:45Z

Global Attributes

← Older revision		Revision as of 09:50, 23 November 2018
Line 22:		Line 22:
	* Comment - A description of the output.		* Comment - A description of the output.
	* NetCDF File Format Version - A unique value for file version, for the 2017 version this is 2.		* NetCDF File Format Version - A unique value for file version, for the 2017 version this is 2.
	* NetCDF Data Type - This is 1 for <u>[[TUFLOW_NetCDF_Raster_Output_Format \| "NC" raster output]]</u> and 2 for cell centered results.		* NetCDF Data Type - This is 1 for <u>[[TUFLOW_NetCDF_Raster_Output_Format \| "NC" raster output]]</u> and 2 for <u>[[TUFLOW_NetCDF_Cell_Centre_Output_Format \| "NC" cell centered results]]</u>.
	An example of the '''Global Attributes''' is:		An example of the '''Global Attributes''' is:
	<pre>		<pre>

Par at 05:06, 10 May 2018

2018-05-10T05:06:27Z

← Older revision		Revision as of 15:06, 10 May 2018
Line 1:		Line 1:
	=Introduction=		=Introduction=
	This page contains information on the NetCDF file format used for cell centered model outputs from a TUFLOW simulation. To specify cell centered NetCDF output from TUFLOW, the 2017 version or later must be used and "~~NCC~~" must be included in the Map Output Data Formats, e.g.<br>		This page contains information on the NetCDF file format used for cell centered model outputs from a TUFLOW simulation. To specify cell centered NetCDF output from TUFLOW, the 2017 version or later must be used and "CC" must be included in the Map Output Data Formats, e.g.<br>
	<font color="blue"><tt>Map Output Format </tt></font> <font color="red"><tt>==</tt></font><tt> xmdf ~~ncc~~ </tt><font color="green"><tt>! Output both xmdf and Cell Centered NetCDF formats</tt></font><br>		<font color="blue"><tt>Map Output Format </tt></font> <font color="red"><tt>==</tt></font><tt> xmdf cc </tt><font color="green"><tt>! Output both xmdf and Cell Centered NetCDF formats</tt></font><br>
	<br>		<br>
	There are a range of additional NetCDF related commands, to control the output further these are:<br>		There are a range of additional NetCDF related commands, to control the output further these are:<br>

Par: /* Global Attributes */

2017-08-23T12:03:49Z

Global Attributes

← Older revision		Revision as of 22:03, 23 August 2017
Line 21:		Line 21:
	* References - The documentation of the NetCDF file, i.e. this page!		* References - The documentation of the NetCDF file, i.e. this page!
	* Comment - A description of the output.		* Comment - A description of the output.
			* NetCDF File Format Version - A unique value for file version, for the 2017 version this is 2.
			* NetCDF Data Type - This is 1 for <u>[[TUFLOW_NetCDF_Raster_Output_Format \| "NC" raster output]]</u> and 2 for cell centered results.
	An example of the '''Global Attributes''' is:		An example of the '''Global Attributes''' is:
	<pre>		<pre>
Line 29:		Line 31:
	comment = 'Contains raster TUFLOW output, TUFLOW netcdf version: 1'		comment = 'Contains raster TUFLOW output, TUFLOW netcdf version: 1'
	</pre>		</pre>

	==Dimensions==		==Dimensions==
	The output NetCDF will have three or four dimensions depending on if the '''Generic''' or '''FEWS''' format has been specified. These are:		The output NetCDF will have three or four dimensions depending on if the '''Generic''' or '''FEWS''' format has been specified. These are:

Par: Created page with "=Introduction= This page contains information on the NetCDF file format used for cell centered model outputs from a TUFLOW simulation. To specify cell centered NetCDF output..."

2017-08-23T11:51:28Z

Created page with "=Introduction= This page contains information on the NetCDF file format used for cell centered model outputs from a TUFLOW simulation. To specify cell centered NetCDF output..."

New page

=Introduction=
This page contains information on the NetCDF file format used for cell centered model outputs from a TUFLOW simulation. To specify cell centered NetCDF output from TUFLOW, the 2017 version or later must be used and "NCC" must be included in the Map Output Data Formats, e.g. 
<tt>Map Output Format </tt> <tt>==</tt><tt> xmdf ncc </tt><tt>! Output both xmdf and Cell Centered NetCDF formats</tt> 
 
There are a range of additional NetCDF related commands, to control the output further these are: 
<tt>NetCDF Output Compression </tt> <tt>==</tt><tt> OFF | {ON} | compression level <0 – 9>
</tt> 
<tt>NetCDF Output Start Date </tt> <tt>==</tt><tt> {2000-01-01 00:00} | OFF | <date in isodate format>
</tt> 
<tt>NetCDF Output Time Unit </tt> <tt>==</tt><tt> DAY | {HOUR} | MINUTE
</tt> 
<tt>NetCDF Output Direction </tt> <tt>==</tt><tt> {ANGLE} | BEARING</tt> 
<tt>NetCDF Output Format </tt> <tt>==</tt><tt> {FEWS} | Generic</tt> 
 
Please refer to the TUFLOW manual for more details on these commands.

==Global Attributes==
The NetCDF file has four global attributes: 
* Title - The simulation name
* Source - The TUFLOW version which has been used
* References - The documentation of the NetCDF file, i.e. this page!
* Comment - A description of the output.
An example of the '''Global Attributes''' is:
<pre>
Global Attributes:
title = 'M01_5m_002_NC2'
source = 'TUFLOW Build: 2015-12-BB-Dev-iSP-w64'
references = 'TUFLOW NetCDF Raster Output Format (http://wiki.tuflow.com/index.php?title=TUFLOW_NetCDF_Raster_Output_Format)'
comment = 'Contains raster TUFLOW output, TUFLOW netcdf version: 1'
</pre>
==Dimensions==
The output NetCDF will have three or four dimensions depending on if the '''Generic''' or '''FEWS''' format has been specified. These are:
* x - the number of x coordinates (columns of data)
* y - the number of y coordinates (rows of data)
* time - the number of outputs. Note that this is an unlimited dimension meaning that the number of time changes each time a new output is written
* static_time (FEWS Format only) - This has a size of 1 and is used for storing a time for the static data (such as maximums)
An example of the '''Dimensions''' is:
<pre>
Dimensions:
x = 1946
y = 856
static_time = 1
time = 161 (UNLIMITED)
</pre>
==Variables==
All outputs for the simulation are written to a single NetCDF file. These are split into three categories:
* Common variables
* Temporal variables
* Non Temporal variables.
For example if the model writes depths our every 10 minutes and tracking maximums is enabled (default) then two depth datasets are written: '''depths''' and '''maximum_depths'''. These are described further below.