Wave:CLI: Difference between revisions

From BlueM
Jump to navigation Jump to search
(→‎Examples: more examples)
(→‎Convert: added option -of DFS0 (since Wave v1.12))
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Wave_nav}}
{{Wave_nav}}


Wave has a commandline interface that offers the commands described below.
Wave has a command-line interface (CLI) that offers the commands described below.


Type <code>Wave.exe -help</code> to get help in the console.
Type <code>Wave.exe -help</code> to get help in the console.
Line 12: Line 12:
Import one or multiple files and then show Wave.
Import one or multiple files and then show Wave.


<div class="info">'''Note:''' Depending on the file format, the file import dialog may be shown when importing files using the CLI. To avoid this, use a [[Wave project file|WVP file]] as input in which the series to import or the import settings are already specified.</div>
<div class="info">'''Notes:'''  
* Depending on the file format, the file import dialog may be shown when importing files using the CLI. To avoid this, use a [[Wave project file|WVP file]] as input in which the series to import or the import settings are already specified.</div>


===Examples===
===Examples===
Line 18: Line 19:
Wave.exe -import path\to\file1.zrx path\to\file2.zrx
Wave.exe -import path\to\file1.zrx path\to\file2.zrx
</pre>
</pre>
Will import the time series contained in the two files <code>file1.zrx</code> and <code>file2.zrx</code>.
Imports the time series contained in the two files <code>file1.zrx</code> and <code>file2.zrx</code>.
 
<hr>
<pre class="dos">
<pre class="dos">
Wave.exe -import path\to\file1.csv
Wave.exe -import path\to\file1.csv
</pre>
</pre>
Will open the File Import Dialog for <code>file1.csv</code> and then import series as specified.
Opens the File Import Dialog for <code>file1.csv</code> and then imports series as specified by the user.


==Convert==
==Convert==
<pre class="dos">
<pre class="dos">
Wave.exe -convert [-i] file1[, file2[, ...]] file_out
Wave.exe -convert [-i] [-of <format>] file1[, file2[, ...]] path_out
</pre>
</pre>


Import one or multiple files and export them as [[CSV-Format|CSV]] to <code>file_out</code>, without showing Wave.
Import one or multiple files and export them to <code>path_out</code>, without showing Wave.


The option <code>-i</code> (interactive) will show the Import File Dialog for files containing multiple time series. Without the option <code>-i</code> (non-interactive), no dialog will be shown and all series from all files will be imported.
The option <code>-i</code> (interactive) will show the Import File Dialog for files containing multiple time series. Without the option <code>-i</code> (non-interactive), no dialog will be shown and all series from all files will be imported.


<div class="info">'''Note:''' To specify which series to import from which files without interaction or to specify more import settings, use a [[Wave project file|WVP file]] as input.</div>
The option <code>-of <format></code> allows you to specify the output format (currently supports <code>[[BIN-Format|BIN]]</code>, <code>[[CSV-Format|CSV]]</code> and <code>[[DFS0-Format|DFS0]]</code>). Without the option <code>-of</code>, the output format is by default CSV.
 
If the output format supports multiple timeseries in one file (e.g. CSV), <code>path_out</code> represents the path to the desired output ''filename''.
 
If the output format only supports a single timeseries per file (e.g. BIN), <code>path_out</code> represents the path to the desired output ''directory''. Output filenames are automatically generated from the time series titles. Use a WVP-file with user-defined titles as input in order to define output file names (see example below).
 
<div class="info">'''Notes:'''  
* Output files will be overwritten.
* To specify which series to import from which files without interaction or to specify more import settings, use a [[Wave project file|WVP file]] as input.
* When converting to DFS0, a dialog will be shown for setting EUM items and units</div>


===Examples===
===Examples===
Line 40: Line 50:
Wave.exe -convert path\to\file1.wel path\to\file2.zrx path\to\file_out.csv
Wave.exe -convert path\to\file1.wel path\to\file2.zrx path\to\file_out.csv
</pre>
</pre>
Will import all the time series contained in the files <code>file1.wel</code> and <code>file2.zrx</code> and export them as CSV to <code>file_out.csv</code>.
Imports all the time series contained in the files <code>file1.wel</code> and <code>file2.zrx</code> and exports them as CSV to <code>file_out.csv</code>.
 
<hr>
<pre class="dos">
<pre class="dos">
Wave.exe -convert -i path\to\file1.wel path\to\file_out.csv
Wave.exe -convert -i path\to\file1.wel path\to\file_out.csv
</pre>
</pre>
Will open the Import File Dialog for selecting the series to import from the file <code>file1.wel</code> and export them as CSV to <code>file_out.csv</code>.
Opens the Import File Dialog for selecting the series to import from the file <code>file1.wel</code> and exports them as CSV to <code>file_out.csv</code>.
 
<hr>
<pre class="dos">
<pre class="dos">
Wave.exe -convert path\to\projectfile.wvp path\to\file_out.csv
Wave.exe -convert path\to\projectfile.wvp path\to\file_out.csv
</pre>
</pre>
Will import series from files as specified in the [[Wave project file]] <code>projectfile.wvp</code> and export them as CSV to <code>file_out.csv</code>.
Imports series from files as specified in the [[Wave project file]] <code>projectfile.wvp</code> and exports them as CSV to <code>file_out.csv</code>.
<hr>
<pre class="dos">
Wave.exe -convert -of BIN path\to\projectfile.wvp path\to\output\directory
</pre>
 
Contents of <code>projectfile.wvp</code>:
<pre>
# project file for converting DFS0 to BIN with custom filenames
file=path\to\input\example.dfs0
    series="series 1":00000001
    series="series 2":00000002
    series="series 3":00000003
</pre>
 
Imports series from files as specified in the [[Wave project file]] <code>projectfile.wvp</code> and exports them in BIN format to <code>path\to\output\directory</code>, using the titles specified in the <code>projectfile.wvp</code> as filenames (in this case <code>00000001.bin</code>, <code>00000002.bin</code> etc.).
 
==Notes==
* Filenames and paths containing spaces or special characters must be enclosed in quotes
* Option <code>-of</code> was added in Wave v1.10.5
* The CLI was added in Wave v1.10.3


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

Latest revision as of 12:40, 13 January 2022

Wave.png Wave | Development

Wave has a command-line interface (CLI) that offers the commands described below.

Type Wave.exe -help to get help in the console.

Import

Wave.exe -import file1[, file2[, ...]]

Import one or multiple files and then show Wave.

Notes:
  • Depending on the file format, the file import dialog may be shown when importing files using the CLI. To avoid this, use a WVP file as input in which the series to import or the import settings are already specified.

Examples

Wave.exe -import path\to\file1.zrx path\to\file2.zrx

Imports the time series contained in the two files file1.zrx and file2.zrx. 

Wave.exe -import path\to\file1.csv

Opens the File Import Dialog for file1.csv and then imports series as specified by the user.

Convert

Wave.exe -convert [-i] [-of <format>] file1[, file2[, ...]] path_out

Import one or multiple files and export them to path_out, without showing Wave.

The option -i (interactive) will show the Import File Dialog for files containing multiple time series. Without the option -i (non-interactive), no dialog will be shown and all series from all files will be imported.

The option -of <format> allows you to specify the output format (currently supports BIN, CSV and DFS0). Without the option -of, the output format is by default CSV.

If the output format supports multiple timeseries in one file (e.g. CSV), path_out represents the path to the desired output filename.

If the output format only supports a single timeseries per file (e.g. BIN), path_out represents the path to the desired output directory. Output filenames are automatically generated from the time series titles. Use a WVP-file with user-defined titles as input in order to define output file names (see example below).

Notes:
  • Output files will be overwritten.
  • To specify which series to import from which files without interaction or to specify more import settings, use a WVP file as input.
  • When converting to DFS0, a dialog will be shown for setting EUM items and units

Examples

Wave.exe -convert path\to\file1.wel path\to\file2.zrx path\to\file_out.csv

Imports all the time series contained in the files file1.wel and file2.zrx and exports them as CSV to file_out.csv. 

Wave.exe -convert -i path\to\file1.wel path\to\file_out.csv

Opens the Import File Dialog for selecting the series to import from the file file1.wel and exports them as CSV to file_out.csv. 

Wave.exe -convert path\to\projectfile.wvp path\to\file_out.csv

Imports series from files as specified in the Wave project file projectfile.wvp and exports them as CSV to file_out.csv. 

Wave.exe -convert -of BIN path\to\projectfile.wvp path\to\output\directory

Contents of projectfile.wvp: 

# project file for converting DFS0 to BIN with custom filenames
file=path\to\input\example.dfs0
    series="series 1":00000001
    series="series 2":00000002
    series="series 3":00000003

Imports series from files as specified in the Wave project file projectfile.wvp and exports them in BIN format to path\to\output\directory, using the titles specified in the projectfile.wvp as filenames (in this case 00000001.bin, 00000002.bin etc.).

Notes

  • Filenames and paths containing spaces or special characters must be enclosed in quotes
  • Option -of was added in Wave v1.10.5
  • The CLI was added in Wave v1.10.3
Retrieved from "https://wiki.bluemodel.org/index.php?title=Wave:CLI&oldid=7647"