Wave project file - Revision history

Froehlich: switch to formatted source

2023-11-11T14:09:11Z

switch to formatted source

← Older revision		Revision as of 07:09, 11 November 2023
Line 6:		Line 6:

	The basic format is as follows:		The basic format is as follows:
	<~~pre~~>		<source lang="wvp">
	file=<path\to\file>		file=<path\to\file>
	series=<series name>		series=<series name>
Line 13:		Line 13:
	series=<series name>		series=<series name>
	series=<series name>		series=<series name>
	</~~pre~~>		</source>

	The <code>file</code> keyword specifies the path to the time series file to import from. The path can be absolute or relative (to the project file). You can specify multiple files.		The <code>file</code> keyword specifies the path to the time series file to import from. The path can be absolute or relative (to the project file). You can specify multiple files.
Line 20:		Line 20:

	'''Note:''' If the series name contains a colon (<code>:</code>), the name has to be enclosed in quotes, e.g.:		'''Note:''' If the series name contains a colon (<code>:</code>), the name has to be enclosed in quotes, e.g.:
	<~~pre~~>		<source lang="wvp">
	series="series:name"		series="series:name"
	</~~pre~~>		</source>

	==Custom titles==		==Custom titles==
	It is possible to specify custom titles by writing the custom title after a colon (<code>:</code>) behind the series name:		It is possible to specify custom titles by writing the custom title after a colon (<code>:</code>) behind the series name:
	<~~pre~~>		<source lang="wvp">
	series=<series name>:my custom title		series=<series name>:my custom title
	</~~pre~~>		</source>

	'''Note:''' If the custom title contains an equal sign (<code>=</code>) or a comma (<code>,</code>), it must be enclosed in quotes, e.g.:		'''Note:''' If the custom title contains an equal sign (<code>=</code>) or a comma (<code>,</code>), it must be enclosed in quotes, e.g.:
	<~~pre~~>		<source lang="wvp">
	series=<series name>:"my , very = custom title"		series=<series name>:"my , very = custom title"
	</~~pre~~>		</source>

	==Series options==		==Series options==
	Additional series options can be specified as a list of comma-separated keyword arguments after a colon (<code>:</code>) behind the series name:		Additional series options can be specified as a list of comma-separated keyword arguments after a colon (<code>:</code>) behind the series name:
	<~~pre~~>		<source lang="wvp">
	series=<series name>:<keyword>=<value>, <keyword>=<value>, ...		series=<series name>:<keyword>=<value>, <keyword>=<value>, ...
	</~~pre~~>		</source>
	'''Note:''' When using keyword options, any custom title must also be specified using the appropriate <code>title</code> keyword.		'''Note:''' When using keyword options, any custom title must also be specified using the appropriate <code>title</code> keyword.

Line 68:		Line 68:
	==Example==		==Example==
	This is a [https://github.com/bluemodel/BlueM.Datasets/blob/master/Wave/WVP/wvp_example.wvp basic example] that loads multiple series from multiple different files of different types:		This is a [https://github.com/bluemodel/BlueM.Datasets/blob/master/Wave/WVP/wvp_example.wvp basic example] that loads multiple series from multiple different files of different types:
	<~~pre~~>		<source lang="wvp">
	# Import multiple series from multiple files		# Import multiple series from multiple files
	#-------------------------------------------		#-------------------------------------------
Line 78:		Line 78:
	file=..\BIN\abfluss_1.bin		file=..\BIN\abfluss_1.bin
	series=abfluss_1.bin: title="Discharge", unit="m3/s", interpretation=Instantaneous, color=Red, linewidth=4, linestyle=Dash, showPoints=True		series=abfluss_1.bin: title="Discharge", unit="m3/s", interpretation=Instantaneous, color=Red, linewidth=4, linestyle=Dash, showPoints=True
	</~~pre~~>		</source>

	==Custom file import settings==		==Custom file import settings==
Line 84:		Line 84:

	Example with all possible settings:		Example with all possible settings:
	<~~pre~~>		<source lang="wvp">
	file=myrandom.csv		file=myrandom.csv
	# custom import settings		# custom import settings
Line 100:		Line 100:
	series=myseries1		series=myseries1
	series=myseries2		series=myseries2
	</~~pre~~>		</source>

	The accepted import settings are described below:		The accepted import settings are described below:

Froehlich: add note about creating/editing/saving

2023-11-11T12:29:37Z

add note about creating/editing/saving

← Older revision		Revision as of 05:29, 11 November 2023
Line 3:		Line 3:
	<div style="float:right; margin:0 0 1em 1em">__TOC__</div>		<div style="float:right; margin:0 0 1em 1em">__TOC__</div>

	A '''Wave project file''' (<code>*.wvp</code>) is a text file that can be used to quickly load multiple series from multiple files at once.		A '''Wave project file''' (<code>*.wvp</code>) is a text file that can be used to quickly load multiple series from multiple files at once. You can create/edit a project file using a text editor or save a project file from within Wave ([[File:Icon_disk.png\|link=]] Save → [[File:Icon_chart_curve_link.png\|link=]] Save project file).

	The basic format is as follows:		The basic format is as follows:

Froehlich: update for v2.6.0

2023-11-11T12:20:53Z

update for v2.6.0

← Older revision		Revision as of 05:20, 11 November 2023
Line 1:		Line 1:
	{{Wave_nav}}		{{Wave_nav}}

			<div style="float:right; margin:0 0 1em 1em">__TOC__</div>

	A '''Wave project file''' (<code>*.wvp</code>) is a text file that can be used to quickly load multiple series from multiple files at once.		A '''Wave project file''' (<code>*.wvp</code>) is a text file that can be used to quickly load multiple series from multiple files at once.
Line 5:		Line 7:
	The basic format is as follows:		The basic format is as follows:
	<pre>		<pre>
	file=path\to\~~file1~~		file=<path\to\file>
	series=~~series1~~		series=<series name>
	series=~~series2: optional title~~		series=<series name>
	file=path\to\~~file2~~		file=<path\to\file>
	series=~~series3: optional title~~		series=<series name>
	series=~~series4~~		series=<series name>
	</pre>		</pre>

			The <code>file</code> keyword specifies the path to the time series file to import from. The path can be absolute or relative (to the project file). You can specify multiple files.

			The <code>series</code> keyword specifies the name of the series to import from the file specified above it. You can specify multiple series per file. If none are specified, all series contained in the file are imported.

	'''Note:''' If the series name contains a colon (<code>:</code>), the name has to be enclosed in quotes, e.g.:		'''Note:''' If the series name contains a colon (<code>:</code>), the name has to be enclosed in quotes, e.g.:
	<pre>		<pre>
	~~file~~=~~path\~~to~~\file~~		series="series:name"
	series="series:name":"custom title"		</pre>

			==Custom titles==
			It is possible to specify custom titles by writing the custom title after a colon (<code>:</code>) behind the series name:
			<pre>
			series=<series name>:my custom title
			</pre>

			'''Note:''' If the custom title contains an equal sign (<code>=</code>) or a comma (<code>,</code>), it must be enclosed in quotes, e.g.:
			<pre>
			series=<series name>:"my , very = custom title"
	</pre>		</pre>

			==Series options==
			Additional series options can be specified as a list of comma-separated keyword arguments after a colon (<code>:</code>) behind the series name:
			<pre>
			series=<series name>:<keyword>=<value>, <keyword>=<value>, ...
			</pre>
			'''Note:''' When using keyword options, any custom title must also be specified using the appropriate <code>title</code> keyword.

			The following keywords are supported:
			* <code>title</code>: assigns a custom title
			* <code>unit</code>: assigns the specified unit
			* <code>interpretation</code>: assigns the specified [[Wave:Interpretation\|interpretation]], must be the name of one of the members of [https://bluemodel.github.io/BlueM.Wave/api/BlueM.Wave.TimeSeries.InterpretationEnum.html <code>BlueM.Wave.TimeSeries.InterpretationEnum</code>], possible values:
			** <code>Instantaneous</code>
			** <code>BlockRight</code>
			** <code>BlockLeft</code>
			** <code>Cumulative</code>
			** <code>CumulativePerTimestep</code>
			** <code>Undefined</code>
			* <code>color</code>: assigns the specified color, can be the name of one of the members of [https://learn.microsoft.com/en-us/dotnet/api/system.drawing.knowncolor?view=netframework-4.8.1 <code>System.Drawing.KnownColor</code>] (e.g. <code>Red</code>) or a hexadecimal representation of ARGB values (e.g. <code>ffff0000</code>)
			* <code>linewidth</code>: assigns the specified line width (default is <code>2</code>)
			* <code>linestyle</code>: assigns the specified line style, must be the name of one of the members of [https://learn.microsoft.com/en-us/dotnet/api/system.drawing.drawing2d.dashstyle?view=netframework-4.8.1 <code>System.Drawing.Drawing2D.DashStyle</code>], possible values:
			** <code>Solid</code> (default)
			** <code>Dash</code>
			** <code>Dot</code>
			** <code>DashDot</code>
			** <code>DashDotDot</code>
			* <code>showpoints</code>: whether to display series points, must be <code>True</code> or <code>False</code>, default is <code>False</code>

			'''Notes:'''
			* Keywords can be specified in any order and are not case-sensitive
			* Values are case-sensitive and must be enclosed in quotes if they contain an equal sign (<code>=</code>) or a comma (<code>,</code>)

	==Example==		==Example==
	This is a basic example that loads multiple series from multiple different files of different types:		This is a [https://github.com/bluemodel/BlueM.Datasets/blob/master/Wave/WVP/wvp_example.wvp basic example] that loads multiple series from multiple different files of different types:
	<pre>		<pre>
	# ~~Read~~ multiple ~~file types~~		# Import multiple series from multiple files
	#-------------------------		#-------------------------------------------
	file=~~REG_SMUSI~~\~~N74235_Mue_10aV2.reg~~		file=..\UVF\42960.0_q_28.uvf
	~~file=~~UVF\42960.0_q_28.uvf		file=..\WEL\DEMONA_PSI.wel
	file=WEL\DEMONA_PSI.wel		series=S3 _1AB: S3 outflow
	series=S3 _1AB: ~~"S3_1AB"~~		series=S3 _1ZU: S3 inflow
	series=S3 _1ZU: ~~"S3_1ZU"~~		file=..\ZRE\Zufl_gem.zre
	file=~~WEL_GISMO~~\~~BEK_WEL~~.~~asc~~		file=..\BIN\abfluss_1.bin
	series=~~BEK_NH4Bek~~: "~~NH4 concentration~~"		series=abfluss_1.bin: title="Discharge", unit="m3/s", interpretation=Instantaneous, color=Red, linewidth=4, linestyle=Dash, showPoints=True
	~~file~~=~~WEL_TALSIM\TALSIM.wel~~
	~~series~~=~~S103_1AB~~
	~~file~~=~~ZRE\Olef_Zufl_gem.zre~~
	~~file~~=~~ZRXP\Q2.1440.zrx~~
	</pre>		</pre>

	==Custom import settings==		==Custom file import settings==
	It is also possible to specify custom import settings. This is useful for generic text or csv files.		It is also possible to specify custom import settings for a file. This is useful for generic text or csv files.

	Example with all possible settings:		Example with all possible settings:
Line 73:		Line 116:
	==Notes==		==Notes==
	* all whitespace apart from linebreaks in the project file is optional		* all whitespace apart from linebreaks in the project file is optional
	* the path to the file can be specified as an absolute path or as a relative path (relative to the project file)
	* if a file is specified without specifying which series should be imported, all series contained in the file will be imported
	* lines starting with <code>#</code> are ignored (treated as comments)		* lines starting with <code>#</code> are ignored (treated as comments)
	* support for this file was added in v1.6.1 (r445)		* support for this file was added in v1.6.1 (r445)
	* support for specifying custom import settings was added in v1.6.2 (r481)		* support for specifying custom file import settings was added in v1.6.2 (r481)
			* support for keyword options was added in v2.6.0

	[[Category:BlueM.Wave]]		[[Category:BlueM.Wave]]

Froehlich: Update for v1.9.3

2021-04-08T16:12:03Z

Update for v1.9.3

← Older revision		Revision as of 09:12, 8 April 2021
Line 11:		Line 11:
	series=series3: optional title		series=series3: optional title
	series=series4		series=series4
			</pre>

			'''Note:''' If the series name contains a colon (<code>:</code>), the name has to be enclosed in quotes, e.g.:
			<pre>
			file=path\to\file
			series="series:name":"custom title"
	</pre>		</pre>

Line 55:		Line 61:
	The accepted import settings are described below:		The accepted import settings are described below:
	* <code>isColumnSeparated</code>: whether the columns are separated by a character (<code>True</code>) or are fixed width (<code>False</code>). Default: <code>True</code>		* <code>isColumnSeparated</code>: whether the columns are separated by a character (<code>True</code>) or are fixed width (<code>False</code>). Default: <code>True</code>
	* <code>separator</code>: the column separator (only relevant if <code>isColumnSeparated=True</code>). Default: <code>;</code>		* <code>separator</code>: the column separator (only relevant if <code>isColumnSeparated=True</code>). Default: <code>;</code>, possible values: <code>space</code>, <code>tab</code>, <code>,</code>, or any other single-character string
	* <code>columnWidth</code>: the column width (only relevant if <code>isColumnSeparated=False</code>). Default: <code>16</code>		* <code>columnWidth</code>: the column width (only relevant if <code>isColumnSeparated=False</code>). Default: <code>16</code>
	* <code>dateformat</code>: the date format (see [https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings help]). Default: <code>dd.MM.yyyy HH:mm</code>		* <code>dateformat</code>: the date format (see [https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings help]). Default: <code>dd.MM.yyyy HH:mm</code>

Froehlich: custom import settings (#720)

2018-09-15T08:00:17Z

custom import settings (#720)

@@ Line 3: / Line 3: @@
 A '''Wave project file''' (<code>*.wvp</code>) is a text file that can be used to quickly load multiple series from multiple files at once.
-The format is as follows:
+The basic format is as follows:
 <pre>
 file=path\to\file1
@@ Line 13: / Line 13: @@
 </pre>
-Example:
+==Example==
 <pre>
-# Test all file types
+# Read multiple file types
-#--------------------
+#-------------------------
 file=REG_SMUSI\N74235_Mue_10aV2.reg
 file=UVF\42960.0_q_28.uvf
@@ Line 30: / Line 31: @@
 </pre>
-'''Notes:'''
+==Custom import settings==
 * the path to the file can be specified as an absolute path or as a relative path (relative to the project file)
-* if no series are specified, all series contained in the file will be loaded
+* if a file is specified without specifying which series should be imported, all series contained in the file will be imported
-* all whitespace in the project file is optional (apart from linebreaks)
+* lines starting with <code>#</code> are ignored (treated as comments)
 * support for this file was added in v1.6.1 (r445)
 [[Category:BlueM.Wave]]

Froehlich at 10:07, 18 November 2017

2017-11-18T10:07:10Z

← Older revision		Revision as of 03:07, 18 November 2017
Line 23:		Line 23:
	series=S3 _1ZU: "S3_1ZU"		series=S3 _1ZU: "S3_1ZU"
	file=WEL_GISMO\BEK_WEL.asc		file=WEL_GISMO\BEK_WEL.asc
	series=BEK_NH4Bek: "NH4 concentration"		series=BEK_NH4Bek: "NH4 concentration"
	file=WEL_TALSIM\TALSIM.wel		file=WEL_TALSIM\TALSIM.wel
	series=S103_1AB		series=S103_1AB
	file=ZRE\Olef_Zufl_gem.zre		file=ZRE\Olef_Zufl_gem.zre
	file=ZRXP\Q2.1440.zrx		file=ZRXP\Q2.1440.zrx

Froehlich: added a more complex example

2017-11-18T10:06:39Z

added a more complex example

← Older revision		Revision as of 03:06, 18 November 2017
Line 15:		Line 15:
	Example:		Example:
	<pre>		<pre>
	file=~~hwmerk_rur~~.~~wel~~		# Test all file types
	~~series~~=~~ERUR_1AB~~		#--------------------
	~~series~~=~~EOLF_1AB~~		file=REG_SMUSI\N74235_Mue_10aV2.reg
	series=~~EURF_1AB~~		file=UVF\42960.0_q_28.uvf
	~~series=EIND_1AB~~		file=WEL\DEMONA_PSI.wel
	series=~~EWUR_1AB~~		series=S3 _1AB: "S3_1AB"
	~~series=EMRZ_1AB~~		series=S3 _1ZU: "S3_1ZU"
	~~series~~=~~SMAU_1AB~~		file=WEL_GISMO\BEK_WEL.asc
	series=~~S456_1AB~~: "~~S456_1AB - Selhausen~~"		series=BEK_NH4Bek: "NH4 concentration"
	~~series~~=~~S397_1AB: "S397_1AB - Altenburg 1"~~		file=WEL_TALSIM\TALSIM.wel
	series=~~S357_1AB: "S357_1AB - Jülich Stadion"~~		series=S103_1AB
	~~series~~=~~S247_1AB: "S247_1AB - Linnich 1"~~		file=ZRE\Olef_Zufl_gem.zre
	~~series~~=~~S008_1AB: "S008_1AB - Stah"~~		file=ZRXP\Q2.1440.zrx
	</pre>		</pre>

Line 34:		Line 34:
	* if no series are specified, all series contained in the file will be loaded		* if no series are specified, all series contained in the file will be loaded
	* all whitespace in the project file is optional (apart from linebreaks)		* all whitespace in the project file is optional (apart from linebreaks)
			* lines not starting whith <code>file=</code> or <code>series=</code> are ignored (useful for adding comments)
	* support for this file was added in v1.6.1 (r445)		* support for this file was added in v1.6.1 (r445)

	[[Category:BlueM.Wave]]		[[Category:BlueM.Wave]]

Froehlich at 15:45, 16 November 2017

2017-11-16T15:45:32Z

← Older revision		Revision as of 08:45, 16 November 2017
Line 31:		Line 31:

	'''Notes:'''		'''Notes:'''
	* support for this file was added in v1.6.1 (r445)
	* the path to the file can be specified as an absolute path or as a relative path (relative to the project file)		* the path to the file can be specified as an absolute path or as a relative path (relative to the project file)
	* if no series are specified, all series contained in the file will be loaded		* if no series are specified, all series contained in the file will be loaded
	* all whitespace in the project file is optional (apart from linebreaks)		* all whitespace in the project file is optional (apart from linebreaks)
			* support for this file was added in v1.6.1 (r445)

	[[Category:BlueM.Wave]]		[[Category:BlueM.Wave]]

Froehlich: Created page with "{{Wave_nav}} A '''Wave project file''' (`*.wvp`) is a text file that can be used to quickly load multiple series from multiple files at once. The format is as fol..."

2017-11-16T15:45:08Z

Created page with "{{Wave_nav}} A '''Wave project file''' (<code>*.wvp</code>) is a text file that can be used to quickly load multiple series from multiple files at once. The format is as fol..."

New page

{{Wave_nav}}

A '''Wave project file''' (<code>*.wvp</code>) is a text file that can be used to quickly load multiple series from multiple files at once.

The format is as follows:
<pre>
file=path\to\file1
series=series1
series=series2: optional title
file=path\to\file2
series=series3: optional title
series=series4
</pre>

Example:
<pre>
file=hwmerk_rur.wel
series=ERUR_1AB
series=EOLF_1AB
series=EURF_1AB
series=EIND_1AB
series=EWUR_1AB
series=EMRZ_1AB
series=SMAU_1AB
series=S456_1AB: "S456_1AB - Selhausen"
series=S397_1AB: "S397_1AB - Altenburg 1"
series=S357_1AB: "S357_1AB - Jülich Stadion"
series=S247_1AB: "S247_1AB - Linnich 1"
series=S008_1AB: "S008_1AB - Stah"
</pre>

'''Notes:'''
* support for this file was added in v1.6.1 (r445)
* the path to the file can be specified as an absolute path or as a relative path (relative to the project file)
* if no series are specified, all series contained in the file will be loaded
* all whitespace in the project file is optional (apart from linebreaks)

[[Category:BlueM.Wave]]