Wave:CLI: Difference between revisions

From BlueM
Jump to navigation Jump to search
(Notes)
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>.


<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 by the user.
Opens the File Import Dialog for <code>file1.csv</code> and then imports series as specified by the user.


==Convert==
==Convert==
Line 34: Line 35:
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>
<div class="info">'''Notes:'''  
* If <code>file_out</code> already exists, it 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.</div>


===Examples===
===Examples===
Line 40: Line 43:
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>.


<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>.


<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>.
 
==Notes==
* The CLI was added in Wave v1.10.3


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

Revision as of 01:15, 26 September 2021

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] file1[, file2[, ...]] file_out

Import one or multiple files and export them as CSV to file_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.

Notes:
  • If file_out already exists, it 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.

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.

Notes

  • The CLI was added in Wave v1.10.3