BlueM - User contributions [en]

BlueM.Wave

2026-05-01T14:51:09Z

Froehlich: /* Features */ remove SWMM binary output format

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[Delft-FEWS PI format]]: <code>*.XML</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GINA result files]]: <code>*.CSV</code>, <code>*.GBL</code>, <code>*.H5</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[File:Wave_Markers.mp4|thumb|Adding and removing markers|cover=File:Wave Markers still.png]]
[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_comments.png|link=]] Interactively add and remove '''markers''' to display series values at selected timestamps
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimeShift|TimeShift]]: Shift time series by a specified time interval
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
File:Wave TimeShift.png|TimeShift|link=Wave:TimeShift
</gallery>

==Commandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

SWMM file formats

2026-05-01T14:50:58Z

Froehlich: remove SWMM binary output format

{{Wave_nav}}

The following [[SWMM]] file formats are supported by BlueM.Wave:
* SWMM5 routing interface file (import/export)
* SWMM5 LID report file (import)
* SWMM5 time series file (import/export)

__TOC__

==SWMM5 routing interface file==
<blockquote>
A routing interface file stores a time series of flows and pollutant concentrations that are discharged from the outfall nodes of drainage system model. This file can serve as the source of inflow to another drainage system model that is connected at the outfalls of the first system.
</blockquote>
: — ''Source: {{:Literature:SWMM_UserManual_5.2|SWMM User's Manual Version 5.2, chapter 11.7.4}}''

SWMM5 routing interface files are expected to have the file extension <code>*.TXT</code> by Wave.

BlueM.Wave detects a SWMM5 routing interface file by checking for the string <code>SWMM5</code> at the beginning of the file.

Example (flow only):
<pre>
SWMM5 Interface File
RTC-Demonstrator , Regenbelastung Wupperverband ,
60 - reporting time step in sec
1 - number of constituents as listed below:
FLOW LPS
5 - number of nodes as listed below:
S101
S201
S401
S203
S602
Node Year Mon Day Hr Min Sec FLOW
S101 2001 6 10 0 0 0 0.000
S201 2001 6 10 0 0 0 0.000
S401 2001 6 10 0 0 0 0.000
S203 2001 6 10 0 0 0 0.000
S602 2001 6 10 0 0 0 0.000
S101 2001 6 10 0 1 0 1.960
S201 2001 6 10 0 1 0 0.420
S401 2001 6 10 0 1 0 1.400
S203 2001 6 10 0 1 0 0.560
S602 2001 6 10 0 1 0 4.900
</pre>

Example (flow and concentrations):
<pre>
SWMM5 Interface File
RTC-Demo
60 - reporting time step in sec
2 - number of constituents as listed below:
FLOW LPS
CSB MG/L
2 - number of nodes as listed below:
S201
S101
Node Year Mon Day Hr Min Sec FLOW CSB
S201 2008 4 1 12 0 0 0.000 50.0000
S101 2008 4 1 12 0 0 0.000 100.0000
S201 2008 4 1 12 1 0 15.625 50.0000
S101 2008 4 1 12 1 0 15.625 100.0000
S201 2008 4 1 12 2 0 15.625 50.0000
S101 2008 4 1 12 2 0 15.625 100.0000
</pre>

==SWMM5 LID report file==
SWMM5 LID report files use the file extension <code>*.TXT</code>. They are recognized by BlueM.Wave by the text <code>SWMM5 LID Report File</code> in the first line.

Example:
<pre>
SWMM5 LID Report File

Project:
LID Unit: BC1 in Subcatchment S_BC

Elapsed Total Total Surface Pavement Soil Storage Surface Drain Surface Pavement Soil Storage
Time Inflow Evap Infil Perc Perc Exfil Runoff OutFlow Level Level Moisture Level
Date Time Hours mm/hr mm/hr mm/hr mm/hr mm/hr mm/hr mm/hr mm/hr mm mm Content mm
----------- -------- --------- --------- --------- --------- --------- --------- --------- --------- --------- --------- --------- --------- ---------
03/01/2018 00:00:00 1344.000 0.000 0.0225 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.192 511.344
03/01/2018 00:05:00 1344.083 0.000 0.0404 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.192 511.344
03/01/2018 00:10:00 1344.167 0.000 0.0404 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.192 511.344
03/01/2018 00:15:00 1344.250 0.000 0.0404 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.192 511.344
03/01/2018 00:20:00 1344.333 0.000 0.0404 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.192 511.344
03/01/2018 00:25:00 1344.417 0.000 0.0404 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.192 511.344
03/01/2018 00:30:00 1344.500 0.000 0.0404 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.192 511.344
03/01/2018 00:35:00 1344.583 0.000 0.0404 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.000 0.192 511.344
</pre>

==SWMM5 time series format==
<blockquote>
Time series files are external text files that contain data for SWMM's time series objects. Examples of time series data include rainfall, evaporation, inflows to nodes of the drainage system, and water stage at outfall boundary nodes. The file must be created and edited outside of SWMM, using a text editor or spreadsheet program. A time series file can be linked to a specific time series object using SWMM's Time Series Editor.
</blockquote>
: — ''Source: {{:Literature:SWMM_UserManual_5.2|SWMM User's Manual Version 5.2, chapter 11.6}}''

This file format is expected to have the file extension <code>*.DAT</code> by Wave.

Wave supports the "date / time / value format", dates are expected to be in month/day/year format.

Example:
<pre>
;Node S101 Total Inflow [LPS]
06/10/2001 12:01 12.960000038147
06/10/2001 12:02 12.960000038147
06/10/2001 12:03 12.960000038147
06/10/2001 12:04 12.960000038147
06/10/2001 12:05 12.960000038147
06/10/2001 12:06 12.960000038147
06/10/2001 12:07 12.960000038147
</pre>

===Notes===
Currently not supported by Wave:
* Support for the SWMM5 binary output format was dropped in Wave v3, see [https://github.com/bluemodel/BlueM.Wave/discussions/229 discussion]
* Omission of repeating dates for timestamps of the same day
* The alternative "time / value format", where time can either be decimal hours or military time since the start of a simulation

==References==
<references/>

[[Category:BlueM.Wave]]
[[Category:SWMM]]
[[Category:Timeseries formats]]

GINA result files

2026-02-07T11:45:56Z

Froehlich: add GINA HDF5 file format (added in v2.14.0)

{{Wave_nav}}

'''[https://bgswasser.de/kompetenzen/software/gina/ GINA]''' is a model used for calculating hydrographs of discharge and pollution concentrations from sewage systems. It outputs result files in the following formats which can be read by Wave:

== GINA CSV WEL format (<code>*.CSV</code>) ==
The GINA CSV WEL format is a CSV format with semicolon separator and additional header lines.

Example:
<pre>
Gew.Typ.:;19 ;;
Grundlast:; 1069.200; l/s;
AEO:; 13.500; km2;
AEOpnat:; 13.728; km2;
T Datum Zeit ; Q_zu; Q_ab; tf;
- ;l/s;l/s;min;
01.01.2003 00:00 ; 1069.2; 1069.2; 10.90;
01.01.2003 00:05 ; 1069.2; 1069.2; 10.90;
01.01.2003 00:10 ; 1069.2; 1069.2; 10.90;
01.01.2003 00:15 ; 1069.2; 1069.2; 10.90;
01.01.2003 00:20 ; 1069.2; 1069.2; 10.90;
01.01.2003 00:25 ; 1069.2; 1069.2; 10.90;
01.01.2003 00:30 ; 1069.2; 1069.2; 10.90;
</pre>

== GINA binary WEL format (<code>*.GBL</code>) ==
The GBL format is a proprietary binary format used to store time series data.

If the GBL file is produced as part of a pollutant scenario, it contains 21 data columns.<br/>
If it is produced as part of a hydraulic scenario, it contains 3 data columns.

=== File Structure ===

==== Header Record ====
The first 8 bytes contain a 64-bit floating-point value (double) with the value −999.0.

The next 4 bytes contain a 32-bit floating-point value (single) with the value:

* −1.0 for pollutant scenario files
* −2.0 for hydraulic scenario files

The remaining bytes in the header are zero-filled:

* 80 bytes of 0.0 for pollutant scenario files
* 8 bytes of 0.0 for hydraulic scenario files

==== Data Records ====
Each record contains:

Column 1: Timestamp (8 bytes, double) — number of hours since 01.01.1601

Remaining columns: Data values (single, 4 bytes each)
* 21 columns for pollutant scenarios
* 3 columns for hydraulic scenarios

== GINA HDF5 Files (<code>*.H5</code>) ==

The GINA HDF5 files contain three groups:

* ERG
* Stichprobe
* timeseries

Of these groups, only the timeseries group is relevant for BlueM.Wave, as the other groups do not contain time series data. The timeseries group contains a subgroup corresponding to the simulated scenario (e.g., HNW for hydraulics, SN2 for pollutants).

These scenario-specific subgroups include:

* a <code>time</code> dataset containing timestamps stored as <code>strings</code>
* one dataset for each simulated river segment, holding the time series for values such as <code>Q_zu</code>, <code>Q_ab</code>, <code>O2_zu</code>, <code>O2_ab</code>, etc.

The attributes <code>Spalten_Einheiten</code> and <code>Spalten_Namen</code> are attached to each subgroup. These attributes are used when selecting data for plotting in Wave, since they provide the names and units for the columns within each dataset.

[[Category:BlueM.Wave]]
[[Category:Timeseries formats]]

BlueM.Wave

2026-02-07T11:28:25Z

Froehlich: /* link= Import time series */ add H5 file extension for GINA result files (added in v2.14.0)

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[Delft-FEWS PI format]]: <code>*.XML</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GINA result files]]: <code>*.CSV</code>, <code>*.GBL</code>, <code>*.H5</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[File:Wave_Markers.mp4|thumb|Adding and removing markers|cover=File:Wave Markers still.png]]
[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_comments.png|link=]] Interactively add and remove '''markers''' to display series values at selected timestamps
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimeShift|TimeShift]]: Shift time series by a specified time interval
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
File:Wave TimeShift.png|TimeShift|link=Wave:TimeShift
</gallery>

==Commandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

OBF-file

2025-11-01T15:58:12Z

Froehlich: /* Common parameters */ add note

{{Template:BlueM.Opt input files}}
<div class="info_versionen">
'''Versions:'''
* '''current''' v1.9
* [{{SERVER}}/index.php?title=OBF-file&oldid=7469 v1.8] (up to r1843)
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7401 v1.7] (as of r1785)
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7274 v1.6] (as of r1762)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6776 v1.4, v1.5] (as of r1524)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6096 v1.3] (as of r1436)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=5843 v1.2.x]
</div>
<div style="float:left; margin:0 10px 10px 0;">__TOC__</div>
This file defines the objective functions for the optimization.

The file must have the same filename as the rest of the dataset's files but have the file extension '''<code>.OBF</code>''', and be located in the same directory as the rest of the dataset. (In version prior to v1.8, this file had the file extension <code>.ZIE</code>.)

<br clear="all"/>

The file is divided into several blocks, each of which is optional. Each block is identified by its heading:
* '''Series''': This block defines objective functions that are based on a comparison of simulation time series with a reference time series.
* '''Values''': This block defines objective functions that are based on a comparison of simulation result values with a reference value (only for [[SWMM]] applications).
* '''ValueFromSeries''': This block defines objective functions that are based on a comparison of values that are computed from simulated time series with reference values.
* '''Aggregate''': Aggregate objective functions

==File format==
<bluem>
*Objective functions
*===================
*
*Series
*------
*
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------------------------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | Evaluation period | Reference series | CurValue |
*| | | | | | | | | Start | End | RefName | RefFile | |
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
| P | Kling-Gupta | | + | | WEL | B401_1AB | KGE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | NashSutcliffe | | + | | WEL | B401_1AB | NSE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | VolumeError | | - | | WEL | B401_1AB | BIAS | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | MeanSquaredError | | - | | WEL | B401_1AB | MSE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
*
*Values
*------
*
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | TargetElement | TargetValue | | CurValue |
*| | | | | | | | | (Block) | (Column) | RefValue | |
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
| S | OutfallLoad | | - | | RPT | | AE | OutfallNode | AvgFlow | 0 | |
| S | Storage401 | Storage | - | + | BLZ | B401 | | Speicher | maxVolume | | |
| S | Storage701 | Storage | - | + | BLZ | B701 | | Speicher | maxVolume | | |
*|-----|---------------|---------|---|-------|-------|-----------|---------|-------------- |-------------|----------|----------|
*
*ValueFromSeries
*---------------
*
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|----------------------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | Evaluation period | Reference value | CurValue |
*| | | | | | | | | Start | Ende | ValueType | RefValue | |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
| S | OutfallLoad | | - | | WEL | B401_1AB | AE | | | | | |
| P | PeakError | | - | | WEL | S3 _1ZU | SE | | | Max | 29.33 | |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
*
*Aggregate
*---------
*
*|-----|--------------|---------|---|----------|
*| Opt | Name | Group | D | CurValue |
*|-----|--------------|---------|---|----------|
| P | TotalStorage | Storage | | |
*|-----|--------------|---------|---|----------|
</bluem>

The width of the columns can be adjusted if necessary, but the column separators (<code>|</code>) must be preserved!

An asterisk (<code>*</code>) at the beginning of the line causes the line to be ignored.

==Description==
===Common parameters===
The blocks "Series", "Values" and "ValuesFromSeries" share a set of parameters.
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! Description
|-
| valign="top" | '''Opt''' || Specifies, whether the objective function is a '''primary objective function''' (<code>P</code>) or a '''secondary objective function''' (<code>S</code>).<br/>Primary objective functions are used to calculate the fitness of invidual solutions.<br/>Secondary objective functions are evaluated, but are not used to determine the fitness of individuals. Secondary objective functions are useful for specifiying objective functions that are part of an aggregated objective function or for specifying values of interest that should be evaluated, but not optimized towards.
|-
| valign="top" | '''Name''' || Arbitrary name of the objective function
|-
| valign="top" | '''Group'''<br/>(optional) || Optional group name, only used for calculating aggregated objective functions. Objective functions with the same group name are aggregated to form one aggregated objective function.
|-
| valign="top" | '''D'''irection<br/>(optional)
|
Direction of desired optimization:
*<code>-</code>: The objective function should be minimized (default)
*<code>+</code>: The objective function should be maximized (this causes the objective function values to be multiplied by <code>-1</code> internally).
|-
| valign="top" | '''Op'''erator or '''Fac'''tor<br/>(optional)
|
Optional, only used for aggregated objective functions
*<code>+</code>: The objective function value is added to the group
*<code>-</code>: The objective function value is subtracted from the group
*''number'': The objective function value is multiplied by the given number and then added to the group
|-
| valign="top" | '''File''' || The file extension of the simulation result file containing the simulation result from which the objective function should be calculated. Supported values:
* <code>WEL</code> (for [[BlueM.Sim]] or [[TALSIM]])
* <code>KWL</code> (only for [[BlueM.Sim]])
* <code>WBL</code> (only for [[TALSIM]])
* <code>KTR.WEL</code>, <code>TEMP.WEL</code>, <code>CHLO.WEL</code> or any other result file with the ending <code>.WEL</code> (only for [[TALSIM]])
* <code>ASC</code> (only for [[SMUSI]] and [[SWMM]])
|-
| valign="top" | '''SimResult''' || The identifier of the simulation result from which the objective function should be calculated.
|-
| valign="top" | '''ObjFunc''' || Specifies which objective function to use.
Supported values for comparing values:
* <code>SE</code>: Squared error
* <code>AE</code>: Absolute error
Supported values for comparing series:
* <code>MAE</code>: Mean abolute error
* <code>SAE</code>: Sum of absolute errors
* <code>MSE</code>: Mean squared error
* <code>SSE</code>: Sum of squared errors
* <code>NSE</code>: Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970|}}
:<code>-∞ ≤ NSE ≤ 1</code>. Larger is better.
:<math>NSE=1-\frac{\sum_{t=1}^T\left(Q_{obs}^t-Q_{sim}^t\right)^2}{\sum_{t=1}^T\left(Q_{obs}^t-\overline{Q_{obs}}\right)^2}</math>
* <code>lnNSE</code>: Logarithmic Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970|}}
:<code>-∞ ≤ lnNSE ≤ 1</code>. Larger is better.
:<math>lnNSE=1-\frac{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-ln(Q_{sim}^t+\epsilon)\right)^2}{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-\overline{ln(Q_{obs}+\epsilon)}\right)^2}</math>
:<code>ε</code> is set to 1% of the average value of <code>Q<sub>obs</sub></code> as recommended by {{:Literatur:Pushpalatha_2012}}.
* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:Kling_2012|}}
:<code>-∞ ≤ KGE ≤ 1</code>. Larger is better.
:<math>\text{KGE} = 1 - \sqrt{ (r - 1)^2 + (\beta - 1)^2 + (\gamma - 1)^2 }</math>
:with
::<code>r</code>: correlation coefficient
::<code>β</code>: bias ratio
::<code>γ</code>: variability ratio
* <code>NGT</code>: Relative number of timesteps in which the simulation result is larger than (exceeds) the value of the reference time series [%]
* <code>SGT</code>: Sum of the simulation values that are larger than the values of the reference time series
* <code>NLT</code>: Relative number of timesteps in which the simulation result is smaller than the value of the reference time series [%]
* <code>SLT</code>: Sum of the simulation values that are smaller than the values of the reference time series
* <code>DET</code>: [https://en.wikipedia.org/wiki/Coefficient_of_determination Coefficient of determination] (simple linear regression) <code>0 ≤ R² ≤ 1</code>:
:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>
* <code>BIAS</code>: Absolute volume error [%]
* <code>APFB</code>: Annual Peak Flow Bias{{:Literatur:Mizukami_2019|}}
:<code>0 ≤ APFB ≤ ∞</code>. Smaller is better.
:<math>\text{APFB} = \sqrt{ (\mu_{peakQ_s} / \mu_{peakQ_o} - 1)^2 }</math>
:with
::<code>μ<sub>peakQ<sub>s</sub></sub></code>: mean of the simulated annual peak flow series
::<code>μ<sub>peakQ<sub>o</sub></sub></code>: mean of the observed annual peak flow series
:NOTE: The division into years begins at the start of the defined evaluation period (or simulation period if not defined)
The following options are '''deprecated''' and only kept for backwards compatibility:
* <code>NashSutt</code>: Modified Nash-Sutcliffe efficiency
:modified formula with <code>0 ≤ NSE<sub>mod</sub> ≤ ∞</code>. Smaller is better.
:<math>NSE_{mod}=1-NSE</math>
* <code>LnNashSutt</code>: Modified logarithmic Nash-Sutcliffe efficiency
:modified formula with <code>0 ≤ lnNSE<sub>mod</sub> ≤ ∞</code>. Smaller is better.
:<math>lnNSE_{mod}=1-lnNSE</math>
|-
| valign="top" | '''CurValue'''<br/>(optional) || An optional value that is displayed in diagrams to serve as an indication of improvement.
|}

==="Series"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
Format: <code>dd.mm.yyyy hh:mm</code><br/>
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
|-
| '''RefName'''<br/>(optional) || Specifies the name of the reference time series. Only necessary if the time series file specified under '''RefFile''' contains multiple series (e.g. [[WEL-format|WEL file]]).
|-
| '''RefFile''' || The filename of the file containing the reference time series<br/><span style="color:red">'''Warning:''' The time step size of the reference series must be identical to that of the simulation result! (see [https://github.com/bluemodel/BlueM.Opt/issues/151 #151])</span>
|}

==="Values"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''TargetElement (Block)''' || Specifies in which section (block) the target variable is located.
|-
| '''TargetValue (Column)''' || Specifies the target variable within the block.
|-
| '''RefValue''' || The reference value with which the simulation result should be compared.
|}

The parameter TargetElement is dependent on the parameter TargetValue and the simulation tool used, only the following combinations are possible:

:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="100" | Application !! width="200" | TargetElement (Block) !! width="200" | TargetValue (Column)
|-
| '''SWMM''' || NodeFlooding || HoursFlooded
|-
| '''SWMM''' || NodeFlooding || FloodVolume
|-
| '''SWMM''' || StorageVolume || AvgVolume
|-
| '''SWMM''' || StorageVolume || AvgPctFull
|-
| '''SWMM''' || StorageVolume || MaxVolume
|-
| '''SWMM''' || StorageVolume || MaxPctFull
|-
| '''SWMM''' || StorageVolume || MaxOutflow
|-
| '''SWMM''' || OutfallLoad || MaxFlow
|-
| '''SWMM''' || OutfallLoad || FlowVolume
|-
| '''SWMM''' || OutfallLoad || Pollutant_[no]
|-
| '''SWMM''' || Pumping || OnlineTime
|-
| '''SWMM''' || Pumping || TotalEnergy
|-
| '''Smusi''' || EntlVolumen || SumVol
|-
| '''Smusi''' || MaxAbfluss || Qmax
|-
| '''Smusi''' || EntlFracht || CSBspez
|}

The TargetValue Pollutant_[no] allows for the evaluation of up to five substances, [no] can take values of 01, 02, 03, 04 or 05, so e.g. specify Pollutant_02 for the second substance.

==="ValueFromSeries"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
Format: <code>dd.mm.yyyy hh:mm</code><br/>
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
|-
| '''ValueType''' || Specifies how to calculate the value from the simulation result series. Supported values:
* <code>Max</code>: Maximum value of the simulation result
* <code>Min</code>: Minimum value of the simulation result
* <code>Avg</code>: Average value of the simulation result
* <code>Start</code>: First value of the simulation result
* <code>End</code>: Last value of the simulation result
* <code>Sum</code>: Sum of the simulation result
|-
| '''RefValue''' || The reference value with which the computed simulation result should be compared.
|}

==Literature==
<references/>

[[Category:BlueM.Opt input files|O]]

OBF-file

2025-11-01T15:52:55Z

Froehlich: /* Common parameters */ typo

{{Template:BlueM.Opt input files}}
<div class="info_versionen">
'''Versions:'''
* '''current''' v1.9
* [{{SERVER}}/index.php?title=OBF-file&oldid=7469 v1.8] (up to r1843)
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7401 v1.7] (as of r1785)
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7274 v1.6] (as of r1762)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6776 v1.4, v1.5] (as of r1524)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6096 v1.3] (as of r1436)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=5843 v1.2.x]
</div>
<div style="float:left; margin:0 10px 10px 0;">__TOC__</div>
This file defines the objective functions for the optimization.

The file must have the same filename as the rest of the dataset's files but have the file extension '''<code>.OBF</code>''', and be located in the same directory as the rest of the dataset. (In version prior to v1.8, this file had the file extension <code>.ZIE</code>.)

<br clear="all"/>

The file is divided into several blocks, each of which is optional. Each block is identified by its heading:
* '''Series''': This block defines objective functions that are based on a comparison of simulation time series with a reference time series.
* '''Values''': This block defines objective functions that are based on a comparison of simulation result values with a reference value (only for [[SWMM]] applications).
* '''ValueFromSeries''': This block defines objective functions that are based on a comparison of values that are computed from simulated time series with reference values.
* '''Aggregate''': Aggregate objective functions

==File format==
<bluem>
*Objective functions
*===================
*
*Series
*------
*
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------------------------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | Evaluation period | Reference series | CurValue |
*| | | | | | | | | Start | End | RefName | RefFile | |
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
| P | Kling-Gupta | | + | | WEL | B401_1AB | KGE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | NashSutcliffe | | + | | WEL | B401_1AB | NSE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | VolumeError | | - | | WEL | B401_1AB | BIAS | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | MeanSquaredError | | - | | WEL | B401_1AB | MSE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
*
*Values
*------
*
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | TargetElement | TargetValue | | CurValue |
*| | | | | | | | | (Block) | (Column) | RefValue | |
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
| S | OutfallLoad | | - | | RPT | | AE | OutfallNode | AvgFlow | 0 | |
| S | Storage401 | Storage | - | + | BLZ | B401 | | Speicher | maxVolume | | |
| S | Storage701 | Storage | - | + | BLZ | B701 | | Speicher | maxVolume | | |
*|-----|---------------|---------|---|-------|-------|-----------|---------|-------------- |-------------|----------|----------|
*
*ValueFromSeries
*---------------
*
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|----------------------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | Evaluation period | Reference value | CurValue |
*| | | | | | | | | Start | Ende | ValueType | RefValue | |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
| S | OutfallLoad | | - | | WEL | B401_1AB | AE | | | | | |
| P | PeakError | | - | | WEL | S3 _1ZU | SE | | | Max | 29.33 | |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
*
*Aggregate
*---------
*
*|-----|--------------|---------|---|----------|
*| Opt | Name | Group | D | CurValue |
*|-----|--------------|---------|---|----------|
| P | TotalStorage | Storage | | |
*|-----|--------------|---------|---|----------|
</bluem>

The width of the columns can be adjusted if necessary, but the column separators (<code>|</code>) must be preserved!

An asterisk (<code>*</code>) at the beginning of the line causes the line to be ignored.

==Description==
===Common parameters===
The blocks "Series", "Values" and "ValuesFromSeries" share a set of parameters.
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! Description
|-
| valign="top" | '''Opt''' || Specifies, whether the objective function is a '''primary objective function''' (<code>P</code>) or a '''secondary objective function''' (<code>S</code>).<br/>Primary objective functions are used to calculate the fitness of invidual solutions.<br/>Secondary objective functions are evaluated, but are not used to determine the fitness of individuals. Secondary objective functions are useful for specifiying objective functions that are part of an aggregated objective function or for specifying values of interest that should be evaluated, but not optimized towards.
|-
| valign="top" | '''Name''' || Arbitrary name of the objective function
|-
| valign="top" | '''Group'''<br/>(optional) || Optional group name, only used for calculating aggregated objective functions. Objective functions with the same group name are aggregated to form one aggregated objective function.
|-
| valign="top" | '''D'''irection<br/>(optional)
|
Direction of desired optimization:
*<code>-</code>: The objective function should be minimized (default)
*<code>+</code>: The objective function should be maximized (this causes the objective function values to be multiplied by <code>-1</code> internally).
|-
| valign="top" | '''Op'''erator or '''Fac'''tor<br/>(optional)
|
Optional, only used for aggregated objective functions
*<code>+</code>: The objective function value is added to the group
*<code>-</code>: The objective function value is subtracted from the group
*''number'': The objective function value is multiplied by the given number and then added to the group
|-
| valign="top" | '''File''' || The file extension of the simulation result file containing the simulation result from which the objective function should be calculated. Supported values:
* <code>WEL</code> (for [[BlueM.Sim]] or [[TALSIM]])
* <code>KWL</code> (only for [[BlueM.Sim]])
* <code>WBL</code> (only for [[TALSIM]])
* <code>KTR.WEL</code>, <code>TEMP.WEL</code>, <code>CHLO.WEL</code> or any other result file with the ending <code>.WEL</code> (only for [[TALSIM]])
* <code>ASC</code> (only for [[SMUSI]] and [[SWMM]])
|-
| valign="top" | '''SimResult''' || The identifier of the simulation result from which the objective function should be calculated.
|-
| valign="top" | '''ObjFunc''' || Specifies which objective function to use.
Supported values for comparing values:
* <code>SE</code>: Squared error
* <code>AE</code>: Absolute error
Supported values for comparing series:
* <code>MAE</code>: Mean abolute error
* <code>SAE</code>: Sum of absolute errors
* <code>MSE</code>: Mean squared error
* <code>SSE</code>: Sum of squared errors
* <code>NSE</code>: Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970|}}
:<code>-∞ ≤ NSE ≤ 1</code>. Larger is better.
:<math>NSE=1-\frac{\sum_{t=1}^T\left(Q_{obs}^t-Q_{sim}^t\right)^2}{\sum_{t=1}^T\left(Q_{obs}^t-\overline{Q_{obs}}\right)^2}</math>
* <code>lnNSE</code>: Logarithmic Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970|}}
:<code>-∞ ≤ lnNSE ≤ 1</code>. Larger is better.
:<math>lnNSE=1-\frac{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-ln(Q_{sim}^t+\epsilon)\right)^2}{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-\overline{ln(Q_{obs}+\epsilon)}\right)^2}</math>
<code>ε</code> is set to 1% of the average value of <code>Q<sub>obs</sub></code> as recommended by {{:Literatur:Pushpalatha_2012}}.
* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:Kling_2012|}}
:<code>-∞ ≤ KGE ≤ 1</code>. Larger is better.
:<math>\text{KGE} = 1 - \sqrt{ (r - 1)^2 + (\beta - 1)^2 + (\gamma - 1)^2 }</math>
:with
::<code>r</code>: correlation coefficient
::<code>β</code>: bias ratio
::<code>γ</code>: variability ratio
* <code>NGT</code>: Relative number of timesteps in which the simulation result is larger than (exceeds) the value of the reference time series [%]
* <code>SGT</code>: Sum of the simulation values that are larger than the values of the reference time series
* <code>NLT</code>: Relative number of timesteps in which the simulation result is smaller than the value of the reference time series [%]
* <code>SLT</code>: Sum of the simulation values that are smaller than the values of the reference time series
* <code>DET</code>: [https://en.wikipedia.org/wiki/Coefficient_of_determination Coefficient of determination] (simple linear regression) <code>0 ≤ R² ≤ 1</code>:
:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>
* <code>BIAS</code>: Absolute volume error [%]
* <code>APFB</code>: Annual Peak Flow Bias{{:Literatur:Mizukami_2019|}}
:<code>0 ≤ APFB ≤ ∞</code>. Smaller is better.
:<math>\text{APFB} = \sqrt{ (\mu_{peakQ_s} / \mu_{peakQ_o} - 1)^2 }</math>
:with
::<code>μ<sub>peakQ<sub>s</sub></sub></code>: mean of the simulated annual peak flow series
::<code>μ<sub>peakQ<sub>o</sub></sub></code>: mean of the observed annual peak flow series
The following options are '''deprecated''' and only kept for backwards compatibility:
* <code>NashSutt</code>: Modified Nash-Sutcliffe efficiency
:modified formula with <code>0 ≤ NSE<sub>mod</sub> ≤ ∞</code>. Smaller is better.
:<math>NSE_{mod}=1-NSE</math>
* <code>LnNashSutt</code>: Modified logarithmic Nash-Sutcliffe efficiency
:modified formula with <code>0 ≤ lnNSE<sub>mod</sub> ≤ ∞</code>. Smaller is better.
:<math>lnNSE_{mod}=1-lnNSE</math>
|-
| valign="top" | '''CurValue'''<br/>(optional) || An optional value that is displayed in diagrams to serve as an indication of improvement.
|}

==="Series"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
Format: <code>dd.mm.yyyy hh:mm</code><br/>
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
|-
| '''RefName'''<br/>(optional) || Specifies the name of the reference time series. Only necessary if the time series file specified under '''RefFile''' contains multiple series (e.g. [[WEL-format|WEL file]]).
|-
| '''RefFile''' || The filename of the file containing the reference time series<br/><span style="color:red">'''Warning:''' The time step size of the reference series must be identical to that of the simulation result! (see [https://github.com/bluemodel/BlueM.Opt/issues/151 #151])</span>
|}

==="Values"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''TargetElement (Block)''' || Specifies in which section (block) the target variable is located.
|-
| '''TargetValue (Column)''' || Specifies the target variable within the block.
|-
| '''RefValue''' || The reference value with which the simulation result should be compared.
|}

The parameter TargetElement is dependent on the parameter TargetValue and the simulation tool used, only the following combinations are possible:

:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="100" | Application !! width="200" | TargetElement (Block) !! width="200" | TargetValue (Column)
|-
| '''SWMM''' || NodeFlooding || HoursFlooded
|-
| '''SWMM''' || NodeFlooding || FloodVolume
|-
| '''SWMM''' || StorageVolume || AvgVolume
|-
| '''SWMM''' || StorageVolume || AvgPctFull
|-
| '''SWMM''' || StorageVolume || MaxVolume
|-
| '''SWMM''' || StorageVolume || MaxPctFull
|-
| '''SWMM''' || StorageVolume || MaxOutflow
|-
| '''SWMM''' || OutfallLoad || MaxFlow
|-
| '''SWMM''' || OutfallLoad || FlowVolume
|-
| '''SWMM''' || OutfallLoad || Pollutant_[no]
|-
| '''SWMM''' || Pumping || OnlineTime
|-
| '''SWMM''' || Pumping || TotalEnergy
|-
| '''Smusi''' || EntlVolumen || SumVol
|-
| '''Smusi''' || MaxAbfluss || Qmax
|-
| '''Smusi''' || EntlFracht || CSBspez
|}

The TargetValue Pollutant_[no] allows for the evaluation of up to five substances, [no] can take values of 01, 02, 03, 04 or 05, so e.g. specify Pollutant_02 for the second substance.

==="ValueFromSeries"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
Format: <code>dd.mm.yyyy hh:mm</code><br/>
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
|-
| '''ValueType''' || Specifies how to calculate the value from the simulation result series. Supported values:
* <code>Max</code>: Maximum value of the simulation result
* <code>Min</code>: Minimum value of the simulation result
* <code>Avg</code>: Average value of the simulation result
* <code>Start</code>: First value of the simulation result
* <code>End</code>: Last value of the simulation result
* <code>Sum</code>: Sum of the simulation result
|-
| '''RefValue''' || The reference value with which the computed simulation result should be compared.
|}

==Literature==
<references/>

[[Category:BlueM.Opt input files|O]]

OBF-file

2025-11-01T15:52:17Z

Froehlich: /* Common parameters */ AFPB (Annual Peak Flow Bias) added in BlueM.Opt v2.5.0

{{Template:BlueM.Opt input files}}
<div class="info_versionen">
'''Versions:'''
* '''current''' v1.9
* [{{SERVER}}/index.php?title=OBF-file&oldid=7469 v1.8] (up to r1843)
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7401 v1.7] (as of r1785)
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7274 v1.6] (as of r1762)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6776 v1.4, v1.5] (as of r1524)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6096 v1.3] (as of r1436)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=5843 v1.2.x]
</div>
<div style="float:left; margin:0 10px 10px 0;">__TOC__</div>
This file defines the objective functions for the optimization.

The file must have the same filename as the rest of the dataset's files but have the file extension '''<code>.OBF</code>''', and be located in the same directory as the rest of the dataset. (In version prior to v1.8, this file had the file extension <code>.ZIE</code>.)

<br clear="all"/>

The file is divided into several blocks, each of which is optional. Each block is identified by its heading:
* '''Series''': This block defines objective functions that are based on a comparison of simulation time series with a reference time series.
* '''Values''': This block defines objective functions that are based on a comparison of simulation result values with a reference value (only for [[SWMM]] applications).
* '''ValueFromSeries''': This block defines objective functions that are based on a comparison of values that are computed from simulated time series with reference values.
* '''Aggregate''': Aggregate objective functions

==File format==
<bluem>
*Objective functions
*===================
*
*Series
*------
*
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------------------------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | Evaluation period | Reference series | CurValue |
*| | | | | | | | | Start | End | RefName | RefFile | |
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
| P | Kling-Gupta | | + | | WEL | B401_1AB | KGE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | NashSutcliffe | | + | | WEL | B401_1AB | NSE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | VolumeError | | - | | WEL | B401_1AB | BIAS | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | MeanSquaredError | | - | | WEL | B401_1AB | MSE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
*
*Values
*------
*
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | TargetElement | TargetValue | | CurValue |
*| | | | | | | | | (Block) | (Column) | RefValue | |
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
| S | OutfallLoad | | - | | RPT | | AE | OutfallNode | AvgFlow | 0 | |
| S | Storage401 | Storage | - | + | BLZ | B401 | | Speicher | maxVolume | | |
| S | Storage701 | Storage | - | + | BLZ | B701 | | Speicher | maxVolume | | |
*|-----|---------------|---------|---|-------|-------|-----------|---------|-------------- |-------------|----------|----------|
*
*ValueFromSeries
*---------------
*
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|----------------------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | Evaluation period | Reference value | CurValue |
*| | | | | | | | | Start | Ende | ValueType | RefValue | |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
| S | OutfallLoad | | - | | WEL | B401_1AB | AE | | | | | |
| P | PeakError | | - | | WEL | S3 _1ZU | SE | | | Max | 29.33 | |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
*
*Aggregate
*---------
*
*|-----|--------------|---------|---|----------|
*| Opt | Name | Group | D | CurValue |
*|-----|--------------|---------|---|----------|
| P | TotalStorage | Storage | | |
*|-----|--------------|---------|---|----------|
</bluem>

The width of the columns can be adjusted if necessary, but the column separators (<code>|</code>) must be preserved!

An asterisk (<code>*</code>) at the beginning of the line causes the line to be ignored.

==Description==
===Common parameters===
The blocks "Series", "Values" and "ValuesFromSeries" share a set of parameters.
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! Description
|-
| valign="top" | '''Opt''' || Specifies, whether the objective function is a '''primary objective function''' (<code>P</code>) or a '''secondary objective function''' (<code>S</code>).<br/>Primary objective functions are used to calculate the fitness of invidual solutions.<br/>Secondary objective functions are evaluated, but are not used to determine the fitness of individuals. Secondary objective functions are useful for specifiying objective functions that are part of an aggregated objective function or for specifying values of interest that should be evaluated, but not optimized towards.
|-
| valign="top" | '''Name''' || Arbitrary name of the objective function
|-
| valign="top" | '''Group'''<br/>(optional) || Optional group name, only used for calculating aggregated objective functions. Objective functions with the same group name are aggregated to form one aggregated objective function.
|-
| valign="top" | '''D'''irection<br/>(optional)
|
Direction of desired optimization:
*<code>-</code>: The objective function should be minimized (default)
*<code>+</code>: The objective function should be maximized (this causes the objective function values to be multiplied by <code>-1</code> internally).
|-
| valign="top" | '''Op'''erator or '''Fac'''tor<br/>(optional)
|
Optional, only used for aggregated objective functions
*<code>+</code>: The objective function value is added to the group
*<code>-</code>: The objective function value is subtracted from the group
*''number'': The objective function value is multiplied by the given number and then added to the group
|-
| valign="top" | '''File''' || The file extension of the simulation result file containing the simulation result from which the objective function should be calculated. Supported values:
* <code>WEL</code> (for [[BlueM.Sim]] or [[TALSIM]])
* <code>KWL</code> (only for [[BlueM.Sim]])
* <code>WBL</code> (only for [[TALSIM]])
* <code>KTR.WEL</code>, <code>TEMP.WEL</code>, <code>CHLO.WEL</code> or any other result file with the ending <code>.WEL</code> (only for [[TALSIM]])
* <code>ASC</code> (only for [[SMUSI]] and [[SWMM]])
|-
| valign="top" | '''SimResult''' || The identifier of the simulation result from which the objective function should be calculated.
|-
| valign="top" | '''ObjFunc''' || Specifies which objective function to use.
Supported values for comparing values:
* <code>SE</code>: Squared error
* <code>AE</code>: Absolute error
Supported values for comparing series:
* <code>MAE</code>: Mean abolute error
* <code>SAE</code>: Sum of absolute errors
* <code>MSE</code>: Mean squared error
* <code>SSE</code>: Sum of squared errors
* <code>NSE</code>: Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970|}}
:<code>-∞ ≤ NSE ≤ 1</code>. Larger is better.
:<math>NSE=1-\frac{\sum_{t=1}^T\left(Q_{obs}^t-Q_{sim}^t\right)^2}{\sum_{t=1}^T\left(Q_{obs}^t-\overline{Q_{obs}}\right)^2}</math>
* <code>lnNSE</code>: Logarithmic Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970|}}
:<code>-∞ ≤ lnNSE ≤ 1</code>. Larger is better.
:<math>lnNSE=1-\frac{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-ln(Q_{sim}^t+\epsilon)\right)^2}{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-\overline{ln(Q_{obs}+\epsilon)}\right)^2}</math>
<code>ε</code> is set to 1% of the average value of <code>Q<sub>obs</sub></code> as recommended by {{:Literatur:Pushpalatha_2012}}.
* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:Kling_2012|}}
:<code>-∞ ≤ KGE ≤ 1</code>. Larger is better.
:<math>\text{KGE} = 1 - \sqrt{ (r - 1)^2 + (\beta - 1)^2 + (\gamma - 1)^2 }</math>
:with
::<code>r</code>: correlation coefficient
::<code>β</code>: bias ratio
::<code>γ</code>: variability ratio
* <code>NGT</code>: Relative number of timesteps in which the simulation result is larger than (exceeds) the value of the reference time series [%]
* <code>SGT</code>: Sum of the simulation values that are larger than the values of the reference time series
* <code>NLT</code>: Relative number of timesteps in which the simulation result is smaller than the value of the reference time series [%]
* <code>SLT</code>: Sum of the simulation values that are smaller than the values of the reference time series
* <code>DET</code>: [https://en.wikipedia.org/wiki/Coefficient_of_determination Coefficient of determination] (simple linear regression) <code>0 ≤ R² ≤ 1</code>:
:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>
* <code>BIAS</code>: Absolute volume error [%]
* <code>AFPB</code>: Annual Peak Flow Bias{{:Literatur:Mizukami_2019|}}
:<code>0 ≤ APFB ≤ ∞</code>. Smaller is better.
:<math>\text{APFB} = \sqrt{ (\mu_{peakQ_s} / \mu_{peakQ_o} - 1)^2 }</math>
:with
::<code>μ<sub>peakQ<sub>s</sub></sub></code>: mean of the simulated annual peak flow series
::<code>μ<sub>peakQ<sub>o</sub></sub></code>: mean of the observed annual peak flow series
The following options are '''deprecated''' and only kept for backwards compatibility:
* <code>NashSutt</code>: Modified Nash-Sutcliffe efficiency
:modified formula with <code>0 ≤ NSE<sub>mod</sub> ≤ ∞</code>. Smaller is better.
:<math>NSE_{mod}=1-NSE</math>
* <code>LnNashSutt</code>: Modified logarithmic Nash-Sutcliffe efficiency
:modified formula with <code>0 ≤ lnNSE<sub>mod</sub> ≤ ∞</code>. Smaller is better.
:<math>lnNSE_{mod}=1-lnNSE</math>
|-
| valign="top" | '''CurValue'''<br/>(optional) || An optional value that is displayed in diagrams to serve as an indication of improvement.
|}

==="Series"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
Format: <code>dd.mm.yyyy hh:mm</code><br/>
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
|-
| '''RefName'''<br/>(optional) || Specifies the name of the reference time series. Only necessary if the time series file specified under '''RefFile''' contains multiple series (e.g. [[WEL-format|WEL file]]).
|-
| '''RefFile''' || The filename of the file containing the reference time series<br/><span style="color:red">'''Warning:''' The time step size of the reference series must be identical to that of the simulation result! (see [https://github.com/bluemodel/BlueM.Opt/issues/151 #151])</span>
|}

==="Values"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''TargetElement (Block)''' || Specifies in which section (block) the target variable is located.
|-
| '''TargetValue (Column)''' || Specifies the target variable within the block.
|-
| '''RefValue''' || The reference value with which the simulation result should be compared.
|}

The parameter TargetElement is dependent on the parameter TargetValue and the simulation tool used, only the following combinations are possible:

:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="100" | Application !! width="200" | TargetElement (Block) !! width="200" | TargetValue (Column)
|-
| '''SWMM''' || NodeFlooding || HoursFlooded
|-
| '''SWMM''' || NodeFlooding || FloodVolume
|-
| '''SWMM''' || StorageVolume || AvgVolume
|-
| '''SWMM''' || StorageVolume || AvgPctFull
|-
| '''SWMM''' || StorageVolume || MaxVolume
|-
| '''SWMM''' || StorageVolume || MaxPctFull
|-
| '''SWMM''' || StorageVolume || MaxOutflow
|-
| '''SWMM''' || OutfallLoad || MaxFlow
|-
| '''SWMM''' || OutfallLoad || FlowVolume
|-
| '''SWMM''' || OutfallLoad || Pollutant_[no]
|-
| '''SWMM''' || Pumping || OnlineTime
|-
| '''SWMM''' || Pumping || TotalEnergy
|-
| '''Smusi''' || EntlVolumen || SumVol
|-
| '''Smusi''' || MaxAbfluss || Qmax
|-
| '''Smusi''' || EntlFracht || CSBspez
|}

The TargetValue Pollutant_[no] allows for the evaluation of up to five substances, [no] can take values of 01, 02, 03, 04 or 05, so e.g. specify Pollutant_02 for the second substance.

==="ValueFromSeries"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
Format: <code>dd.mm.yyyy hh:mm</code><br/>
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
|-
| '''ValueType''' || Specifies how to calculate the value from the simulation result series. Supported values:
* <code>Max</code>: Maximum value of the simulation result
* <code>Min</code>: Minimum value of the simulation result
* <code>Avg</code>: Average value of the simulation result
* <code>Start</code>: First value of the simulation result
* <code>End</code>: Last value of the simulation result
* <code>Sum</code>: Sum of the simulation result
|-
| '''RefValue''' || The reference value with which the computed simulation result should be compared.
|}

==Literature==
<references/>

[[Category:BlueM.Opt input files|O]]

Literature:Mizukami 2019

2025-11-01T15:42:54Z

Froehlich: Created page with "{{{1|Mizukami et al. (2019)}}}<ref name="mizukami_2019">'''Mizukami, N., Rakovec, O., Newman, A. J., Clark, M. P., Wood, A. W., Gupta, H. V., and Kumar, R.''' (2019): On the choice of calibration metrics for “high-flow” estimation using hydrologic models, Hydrol. Earth Syst. Sci., 23, 2601–2614, https://doi.org/10.5194/hess-23-2601-2019.</ref><noinclude> ==Vorschau== <references/> </noinclude>"

{{{1|Mizukami et al. (2019)}}}<ref name="mizukami_2019">'''Mizukami, N., Rakovec, O., Newman, A. J., Clark, M. P., Wood, A. W., Gupta, H. V., and Kumar, R.''' (2019): On the choice of calibration metrics for “high-flow” estimation using hydrologic models, Hydrol. Earth Syst. Sci., 23, 2601–2614, https://doi.org/10.5194/hess-23-2601-2019.</ref><noinclude>

==Vorschau==
<references/>
</noinclude>

OBF-file

2025-11-01T15:27:04Z

Froehlich: /* Common parameters */ table formatting

{{Template:BlueM.Opt input files}}
<div class="info_versionen">
'''Versions:'''
* '''current''' v1.9
* [{{SERVER}}/index.php?title=OBF-file&oldid=7469 v1.8] (up to r1843)
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7401 v1.7] (as of r1785)
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7274 v1.6] (as of r1762)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6776 v1.4, v1.5] (as of r1524)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6096 v1.3] (as of r1436)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=5843 v1.2.x]
</div>
<div style="float:left; margin:0 10px 10px 0;">__TOC__</div>
This file defines the objective functions for the optimization.

The file must have the same filename as the rest of the dataset's files but have the file extension '''<code>.OBF</code>''', and be located in the same directory as the rest of the dataset. (In version prior to v1.8, this file had the file extension <code>.ZIE</code>.)

<br clear="all"/>

The file is divided into several blocks, each of which is optional. Each block is identified by its heading:
* '''Series''': This block defines objective functions that are based on a comparison of simulation time series with a reference time series.
* '''Values''': This block defines objective functions that are based on a comparison of simulation result values with a reference value (only for [[SWMM]] applications).
* '''ValueFromSeries''': This block defines objective functions that are based on a comparison of values that are computed from simulated time series with reference values.
* '''Aggregate''': Aggregate objective functions

==File format==
<bluem>
*Objective functions
*===================
*
*Series
*------
*
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------------------------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | Evaluation period | Reference series | CurValue |
*| | | | | | | | | Start | End | RefName | RefFile | |
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
| P | Kling-Gupta | | + | | WEL | B401_1AB | KGE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | NashSutcliffe | | + | | WEL | B401_1AB | NSE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | VolumeError | | - | | WEL | B401_1AB | BIAS | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
| S | MeanSquaredError | | - | | WEL | B401_1AB | MSE | 30.05.1984 00:00 | 18.06.1984 23:30 | | seriesfile.zre | |
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
*
*Values
*------
*
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | TargetElement | TargetValue | | CurValue |
*| | | | | | | | | (Block) | (Column) | RefValue | |
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
| S | OutfallLoad | | - | | RPT | | AE | OutfallNode | AvgFlow | 0 | |
| S | Storage401 | Storage | - | + | BLZ | B401 | | Speicher | maxVolume | | |
| S | Storage701 | Storage | - | + | BLZ | B701 | | Speicher | maxVolume | | |
*|-----|---------------|---------|---|-------|-------|-----------|---------|-------------- |-------------|----------|----------|
*
*ValueFromSeries
*---------------
*
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|----------------------|----------|
*| Opt | Name | Group | D | OpFac | File | SimResult | ObjFunc | Evaluation period | Reference value | CurValue |
*| | | | | | | | | Start | Ende | ValueType | RefValue | |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
| S | OutfallLoad | | - | | WEL | B401_1AB | AE | | | | | |
| P | PeakError | | - | | WEL | S3 _1ZU | SE | | | Max | 29.33 | |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
*
*Aggregate
*---------
*
*|-----|--------------|---------|---|----------|
*| Opt | Name | Group | D | CurValue |
*|-----|--------------|---------|---|----------|
| P | TotalStorage | Storage | | |
*|-----|--------------|---------|---|----------|
</bluem>

The width of the columns can be adjusted if necessary, but the column separators (<code>|</code>) must be preserved!

An asterisk (<code>*</code>) at the beginning of the line causes the line to be ignored.

==Description==
===Common parameters===
The blocks "Series", "Values" and "ValuesFromSeries" share a set of parameters.
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! Description
|-
| valign="top" | '''Opt''' || Specifies, whether the objective function is a '''primary objective function''' (<code>P</code>) or a '''secondary objective function''' (<code>S</code>).<br/>Primary objective functions are used to calculate the fitness of invidual solutions.<br/>Secondary objective functions are evaluated, but are not used to determine the fitness of individuals. Secondary objective functions are useful for specifiying objective functions that are part of an aggregated objective function or for specifying values of interest that should be evaluated, but not optimized towards.
|-
| valign="top" | '''Name''' || Arbitrary name of the objective function
|-
| valign="top" | '''Group'''<br/>(optional) || Optional group name, only used for calculating aggregated objective functions. Objective functions with the same group name are aggregated to form one aggregated objective function.
|-
| valign="top" | '''D'''irection<br/>(optional)
|
Direction of desired optimization:
*<code>-</code>: The objective function should be minimized (default)
*<code>+</code>: The objective function should be maximized (this causes the objective function values to be multiplied by <code>-1</code> internally).
|-
| valign="top" | '''Op'''erator or '''Fac'''tor<br/>(optional)
|
Optional, only used for aggregated objective functions
*<code>+</code>: The objective function value is added to the group
*<code>-</code>: The objective function value is subtracted from the group
*''number'': The objective function value is multiplied by the given number and then added to the group
|-
| valign="top" | '''File''' || The file extension of the simulation result file containing the simulation result from which the objective function should be calculated. Supported values:
* <code>WEL</code> (for [[BlueM.Sim]] or [[TALSIM]])
* <code>KWL</code> (only for [[BlueM.Sim]])
* <code>WBL</code> (only for [[TALSIM]])
* <code>KTR.WEL</code>, <code>TEMP.WEL</code>, <code>CHLO.WEL</code> or any other result file with the ending <code>.WEL</code> (only for [[TALSIM]])
* <code>ASC</code> (only for [[SMUSI]] and [[SWMM]])
|-
| valign="top" | '''SimResult''' || The identifier of the simulation result from which the objective function should be calculated.
|-
| valign="top" | '''ObjFunc''' || Specifies which objective function to use.
Supported values for comparing values:
* <code>SE</code>: Squared error
* <code>AE</code>: Absolute error
Supported values for comparing series:
* <code>MAE</code>: Mean abolute error
* <code>SAE</code>: Sum of absolute errors
* <code>MSE</code>: Mean squared error
* <code>SSE</code>: Sum of squared errors
* <code>NSE</code>: Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970|}}
:<code>-∞ ≤ NSE ≤ 1</code>. Larger is better.
:<math>NSE=1-\frac{\sum_{t=1}^T\left(Q_{obs}^t-Q_{sim}^t\right)^2}{\sum_{t=1}^T\left(Q_{obs}^t-\overline{Q_{obs}}\right)^2}</math>
* <code>lnNSE</code>: Logarithmic Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970|}}
:<code>-∞ ≤ lnNSE ≤ 1</code>. Larger is better.
:<math>lnNSE=1-\frac{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-ln(Q_{sim}^t+\epsilon)\right)^2}{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-\overline{ln(Q_{obs}+\epsilon)}\right)^2}</math>
<code>ε</code> is set to 1% of the average value of <code>Q<sub>obs</sub></code> as recommended by {{:Literatur:Pushpalatha_2012}}.
* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:Kling_2012|}}
:<code>-∞ ≤ KGE ≤ 1</code>. Larger is better.
:<math>\text{KGE} = 1 - \sqrt{ (r - 1)^2 + (\beta - 1)^2 + (\gamma - 1)^2 }</math>
:with
::<code>r</code>: correlation coefficient
::<code>β</code>: bias ratio
::<code>γ</code>: variability ratio
* <code>NGT</code>: Relative number of timesteps in which the simulation result is larger than (exceeds) the value of the reference time series [%]
* <code>SGT</code>: Sum of the simulation values that are larger than the values of the reference time series
* <code>NLT</code>: Relative number of timesteps in which the simulation result is smaller than the value of the reference time series [%]
* <code>SLT</code>: Sum of the simulation values that are smaller than the values of the reference time series
* <code>DET</code>: [https://en.wikipedia.org/wiki/Coefficient_of_determination Coefficient of determination] (simple linear regression) <code>0 ≤ R² ≤ 1</code>:
:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>
* <code>BIAS</code>: Absolute volume error [%]
The following options are '''deprecated''' and only kept for backwards compatibility:
* <code>NashSutt</code>: Modified Nash-Sutcliffe efficiency
:modified formula with <code>0 ≤ NSE<sub>mod</sub> ≤ ∞</code>. Smaller is better.
:<math>NSE_{mod}=1-NSE</math>
* <code>LnNashSutt</code>: Modified logarithmic Nash-Sutcliffe efficiency
:modified formula with <code>0 ≤ lnNSE<sub>mod</sub> ≤ ∞</code>. Smaller is better.
:<math>lnNSE_{mod}=1-lnNSE</math>
|-
| valign="top" | '''CurValue'''<br/>(optional) || An optional value that is displayed in diagrams to serve as an indication of improvement.
|}

==="Series"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
Format: <code>dd.mm.yyyy hh:mm</code><br/>
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
|-
| '''RefName'''<br/>(optional) || Specifies the name of the reference time series. Only necessary if the time series file specified under '''RefFile''' contains multiple series (e.g. [[WEL-format|WEL file]]).
|-
| '''RefFile''' || The filename of the file containing the reference time series<br/><span style="color:red">'''Warning:''' The time step size of the reference series must be identical to that of the simulation result! (see [https://github.com/bluemodel/BlueM.Opt/issues/151 #151])</span>
|}

==="Values"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''TargetElement (Block)''' || Specifies in which section (block) the target variable is located.
|-
| '''TargetValue (Column)''' || Specifies the target variable within the block.
|-
| '''RefValue''' || The reference value with which the simulation result should be compared.
|}

The parameter TargetElement is dependent on the parameter TargetValue and the simulation tool used, only the following combinations are possible:

:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="100" | Application !! width="200" | TargetElement (Block) !! width="200" | TargetValue (Column)
|-
| '''SWMM''' || NodeFlooding || HoursFlooded
|-
| '''SWMM''' || NodeFlooding || FloodVolume
|-
| '''SWMM''' || StorageVolume || AvgVolume
|-
| '''SWMM''' || StorageVolume || AvgPctFull
|-
| '''SWMM''' || StorageVolume || MaxVolume
|-
| '''SWMM''' || StorageVolume || MaxPctFull
|-
| '''SWMM''' || StorageVolume || MaxOutflow
|-
| '''SWMM''' || OutfallLoad || MaxFlow
|-
| '''SWMM''' || OutfallLoad || FlowVolume
|-
| '''SWMM''' || OutfallLoad || Pollutant_[no]
|-
| '''SWMM''' || Pumping || OnlineTime
|-
| '''SWMM''' || Pumping || TotalEnergy
|-
| '''Smusi''' || EntlVolumen || SumVol
|-
| '''Smusi''' || MaxAbfluss || Qmax
|-
| '''Smusi''' || EntlFracht || CSBspez
|}

The TargetValue Pollutant_[no] allows for the evaluation of up to five substances, [no] can take values of 01, 02, 03, 04 or 05, so e.g. specify Pollutant_02 for the second substance.

==="ValueFromSeries"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="150" | Parameter !! width="500" | Description
|-
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
Format: <code>dd.mm.yyyy hh:mm</code><br/>
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
|-
| '''ValueType''' || Specifies how to calculate the value from the simulation result series. Supported values:
* <code>Max</code>: Maximum value of the simulation result
* <code>Min</code>: Minimum value of the simulation result
* <code>Avg</code>: Average value of the simulation result
* <code>Start</code>: First value of the simulation result
* <code>End</code>: Last value of the simulation result
* <code>Sum</code>: Sum of the simulation result
|-
| '''RefValue''' || The reference value with which the computed simulation result should be compared.
|}

==Literature==
<references/>

[[Category:BlueM.Opt input files|O]]

GINA result files

2025-10-09T16:56:23Z

Froehlich: /* GINA binary WEL format (*.GBL) */ update from https://github.com/bluemodel/BlueM.Wave/pull/212

File:Wave Markers.gif

2025-10-05T12:29:17Z

Froehlich:

File:Wave Markers still.png

2025-10-05T10:37:18Z

Froehlich: Froehlich uploaded a new version of File:Wave Markers still.png

File:Wave Markers.mp4

2025-10-05T10:30:35Z

Froehlich: Froehlich uploaded a new version of File:Wave Markers.mp4

BlueM.Wave

2025-10-04T13:51:41Z

Froehlich: /* Visualization & Navigation */

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[Delft-FEWS PI format]]: <code>*.XML</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GINA result files]]: <code>*.CSV</code>, <code>*.GBL</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[File:Wave_Markers.mp4|thumb|Adding and removing markers|cover=File:Wave Markers still.png]]
[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_comments.png|link=]] Interactively add and remove '''markers''' to display series values at selected timestamps
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimeShift|TimeShift]]: Shift time series by a specified time interval
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
File:Wave TimeShift.png|TimeShift|link=Wave:TimeShift
</gallery>

==Commandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

BlueM.Wave

2025-10-04T13:50:49Z

Froehlich: /* Visualization & Navigation */

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[Delft-FEWS PI format]]: <code>*.XML</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GINA result files]]: <code>*.CSV</code>, <code>*.GBL</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[File:Wave_Markers.mp4|thumb|Adding and removing markers|cover=File:Wave Markers still.png]]
[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_comments.png|link=]] Interactively add and remove markers to display series values at selected timestamps
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimeShift|TimeShift]]: Shift time series by a specified time interval
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
File:Wave TimeShift.png|TimeShift|link=Wave:TimeShift
</gallery>

==Commandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

File:Wave Markers still.png

2025-10-04T13:49:36Z

Froehlich:

BlueM.Wave

2025-10-04T13:29:05Z

Froehlich: /* Visualization & Navigation */

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[Delft-FEWS PI format]]: <code>*.XML</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GINA result files]]: <code>*.CSV</code>, <code>*.GBL</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[File:Wave_Markers.mp4|thumb|Adding and removing markers]]
[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_comments.png|link=]] Interactively add and remove markers to display series values at selected timestamps
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimeShift|TimeShift]]: Shift time series by a specified time interval
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
File:Wave TimeShift.png|TimeShift|link=Wave:TimeShift
</gallery>

==Commandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

File:Wave Markers.mp4

2025-10-04T13:27:55Z

Froehlich: Froehlich moved page File:Wave Crosshair.mp4 to File:Wave Markers.mp4 without leaving a redirect

BlueM.Wave

2025-10-04T13:25:56Z

Froehlich: /* Visualization & Navigation */ Markers

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[Delft-FEWS PI format]]: <code>*.XML</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GINA result files]]: <code>*.CSV</code>, <code>*.GBL</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[File:Wave_Crosshair.mp4|thumb|Adding and removing markers]]
[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_comments.png|link=]] Interactively add and remove markers to display series values at selected timestamps
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimeShift|TimeShift]]: Shift time series by a specified time interval
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
File:Wave TimeShift.png|TimeShift|link=Wave:TimeShift
</gallery>

==Commandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

File:Wave Markers.mp4

2025-10-04T13:18:53Z

Froehlich: Froehlich uploaded a new version of File:Wave Crosshair.mp4

File:Wave Markers.mp4

2025-10-04T12:44:43Z

Froehlich:

Wave:TimestepAnalysis

2025-09-27T14:12:36Z

Froehlich:

{{Wave_nav}}

[[File:Wave TimestepAnalysis.png|thumb|right]]

This analysis function calculates the time difference between each node and returns a new time series of the differences in the user-specified unit.

[[Category:BlueM.Wave|T]]
[[Category:Analysis functions|T]]

BlueM.Wave

2025-09-27T10:54:06Z

Froehlich: /* Edit & Analyze */ add analysis function TimeShift

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[Delft-FEWS PI format]]: <code>*.XML</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GINA result files]]: <code>*.CSV</code>, <code>*.GBL</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimeShift|TimeShift]]: Shift time series by a specified time interval
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
File:Wave TimeShift.png|TimeShift|link=Wave:TimeShift
</gallery>

==Commandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

Wave:TimeShift

2025-09-27T10:52:35Z

Froehlich: Created page with "{{Wave_nav}} right This analysis function shifts one or more time series by the specified time interval. ==Notes== * When shifting by years, leap days may be lost if the target year is not a leap year * When shifting by months, days at the end of the month may be lost if the target month has fewer days T T"

{{Wave_nav}}

[[File:Wave TimeShift.png|thumb|right]]

This analysis function shifts one or more time series by the specified time interval.

==Notes==
* When shifting by years, leap days may be lost if the target year is not a leap year
* When shifting by months, days at the end of the month may be lost if the target month has fewer days

[[Category:BlueM.Wave|T]]
[[Category:Analysis functions|T]]

File:Wave TimeShift.png

2025-09-27T10:50:26Z

Froehlich:

Screenshot of TimeShift analysis function

BlueM.Wave

2025-09-25T18:53:21Z

Froehlich: /* Features */

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[Delft-FEWS PI format]]: <code>*.XML</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GINA result files]]: <code>*.CSV</code>, <code>*.GBL</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
</gallery>

==Commandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

GINA result files

2025-09-25T18:53:04Z

Froehlich: added GINA CSV WEL

GBL-Format

2025-09-25T18:40:26Z

Froehlich: Froehlich moved page GBL-Format to GINA result files

#REDIRECT [[GINA result files]]

GINA result files

2025-09-25T18:40:26Z

Froehlich: Froehlich moved page GBL-Format to GINA result files

{{Wave_nav}}

The GINA binary wel (GBL) format is a proprietary binary format for timeseries which is used by [https://bgswasser.de/kompetenzen/software/gina/ GINA].

The GBL format consists of 21 data columns.

The first column contains the timestamp as a 8 bytes double. The timestamp is defined as hours since 01.01.1601.

The remaining columns are data columns stored as 4 bytes single.

Wave can read GBL files.

[[Category:BlueM.Wave]]
[[Category:Timeseries formats]]

BlueM.Wave

2025-09-07T19:16:16Z

Froehlich: /* Comandline interface */

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[Delft-FEWS PI format]]: <code>*.XML</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GBL-Format | GINA result files]]: <code>*.GBL</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
</gallery>

==Commandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

BlueM.Wave

2025-09-07T19:16:02Z

Froehlich: Added FEWS PI format

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[Delft-FEWS PI format]]: <code>*.XML</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GBL-Format | GINA result files]]: <code>*.GBL</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
</gallery>

==Comandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

Delft-FEWS PI format

2025-09-07T19:15:06Z

Froehlich: Created page with "{{Wave_nav}} The Delft-Fews Published interface format (PI) consists of a number of xsd schemas defining a number of XML formats for the exchange of data. The timeseries format deals with (scalar) timeseries data. File format documentation: https://publicwiki.deltares.nl/spaces/FEWSDOC/pages/8683960/Delft-Fews+Published+Interface+timeseries+Format+PI+Import BlueM.Wave can read and write time series in FEWS PI format. == Notes == * When importing, the combination of <..."

{{Wave_nav}}

The Delft-Fews Published interface format (PI) consists of a number of xsd schemas defining a number of XML formats for the exchange of data. The timeseries format deals with (scalar) timeseries data.

File format documentation: https://publicwiki.deltares.nl/spaces/FEWSDOC/pages/8683960/Delft-Fews+Published+Interface+timeseries+Format+PI+Import

BlueM.Wave can read and write time series in FEWS PI format.

== Notes ==
* When importing, the combination of <code>locationId</code> and <code>parameterId</code> is used as the time series title: <code><locationId>.<parameterId></code>
* When exporting, the <code>event</code>'s <code>flag</code> attribute is always set to <code>2</code> ("Completed/Reliable", see https://publicwiki.deltares.nl/spaces/FEWSDOC/pages/8684161/D+Time+Series+Flags)
* The following table shows the mapping used between FEWS PI <code>type</code> and BlueM.Wave interpretation:
{| class="wikitable"
|-
! FEWS PI !! BlueM.Wave
|-
| instantaneous || Instantaneous
|-
| mean || BlockRight
|-
| accumulative || CumulativePerTimestep
|}

[[Category:BlueM.Wave]]
[[Category:Timeseries formats]]

Wave:Calculator

2025-09-02T20:44:07Z

Froehlich: update URL to MathParserNet

{{Wave_nav}}

[[File:Wave Calculator.png|frame|right]]

The Calculator analysis function performs mathematical operations on time series.

The mathematical operations to be performed are entered as a formula or mathematical expression. The formula is individually applied to each of the timestamps contained in the series that were selected for the analysis. The result is a new time series.

When entering a formula, you must use default programming syntax for numbers, with <code>.</code> (point) as decimal delimiter, e.g. <code>1.5</code>, irrespective of your operating system settings.

The following mathematical operators and functions are supported:

*<code>()</code>: Parenthesis
*<code>+</code>: Addition operator e.g. <code>3 + 2</code>
*<code>-</code>: Subtraction operator e.g. <code>3 - 2</code>
*<code>*</code>: Multiplication operator e.g. <code>3 * 2</code>
*<code>/</code>: Division operator e.g. <code>3 / 2</code>
*<code>%</code>: Modulus operator e.g. <code>3 % 2</code> (divides the two numbers, but returns the remainder)
*<code>^</code>: Exponent operator e.g. <code>3 ^ 2</code>
*<code>ABS</code>: Returns the absolute of a number e.g. <code>ABS(-3)</code>
*<code>SIN</code>: Returns the sine of a number e.g. <code>SIN(3.14)</code>
*<code>COS</code>: Returns the cosine of a number e.g. <code>COS(3.14)</code>
*<code>TAN</code>: Returns the tangent of a number e.g. <code>TAN(3.14)</code>
*<code>LOG</code>: Returns the base 10 logarithm of a number e.g. <code>LOG(3)</code>
*<code>LOGN</code>: Returns the natural logarithm of a number e.g. <code>LOGN(4)</code>
*<code>MAX</code>: Returns the maximum of two numbers e.g. <code>MAX(4, 6)</code>
*<code>MIN</code>: Returns the minimum of two numbers e.g. <code>MIN(4, 6)</code>

Time series selected for the analysis can be added to the formula as variables either by entering the letter representing the time series manually or by double-clicking the time series in the list box.

The calculation only results in a number value for those timestamps that are common to all of the time series selected for analysis. If a timestamp is missing in one or more time series or the value of one or more time series is NaN for a timestamp, the resulting time series will have a NaN value for this particular timestamp.

Examples:
* <code>100</code> (without any variables):
: results in a time series with the value of 100 for each timestamp
* <code>A / 100</code> (where A is a time series):
: results in a time series where all values of A are divided by 100
* <code>A + B</code> (where A and B are time series):
: results in a time series where the values of A and B are added to together for each common timestamp
* <code>MAX(A, B)</code> (where A and B are time series):
: results in a time series with the maximum values from A and B
* <code>(2 * A) + LOG(B) - ABS(C) - 0.5</code> (where A, B and C are time series):
: complex calculation with multiple time series

Notes:
* Added in Wave v1.9.4
* The [https://github.com/bluemodel/MathParserNet MathParserNet] library is used for parsing and evaluating the mathematical expression.

[[Category:BlueM.Wave|C]]
[[Category:Analysis functions|C]]

BlueM.Wave

2025-09-02T19:45:42Z

Froehlich: /* link= Import time series */ add GINA GBL files

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[GBL-Format | GINA result files]]: <code>*.GBL</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
</gallery>

==Comandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

GINA result files

2025-09-02T19:45:14Z

Froehlich: Created page with "{{Wave_nav}} The GINA binary wel (GBL) format is a proprietary binary format for timeseries which is used by [https://bgswasser.de/kompetenzen/software/gina/ GINA]. The GBL format consists of 21 data columns. The first column contains the timestamp as a 8 bytes double. The timestamp is defined as hours since 01.01.1601. The remaining columns are data columns stored as 4 bytes single. Wave can read GBL files. Category:BlueM.Wave Category:Timeseries formats"

Wave:Calculator

2025-09-01T15:13:20Z

Froehlich: Add info about syntax

{{Wave_nav}}

[[File:Wave Calculator.png|frame|right]]

The Calculator analysis function performs mathematical operations on time series.

The mathematical operations to be performed are entered as a formula or mathematical expression. The formula is individually applied to each of the timestamps contained in the series that were selected for the analysis. The result is a new time series.

When entering a formula, you must use default programming syntax for numbers, with <code>.</code> (point) as decimal delimiter, e.g. <code>1.5</code>, irrespective of your operating system settings.

The following mathematical operators and functions are supported:

*<code>()</code>: Parenthesis
*<code>+</code>: Addition operator e.g. <code>3 + 2</code>
*<code>-</code>: Subtraction operator e.g. <code>3 - 2</code>
*<code>*</code>: Multiplication operator e.g. <code>3 * 2</code>
*<code>/</code>: Division operator e.g. <code>3 / 2</code>
*<code>%</code>: Modulus operator e.g. <code>3 % 2</code> (divides the two numbers, but returns the remainder)
*<code>^</code>: Exponent operator e.g. <code>3 ^ 2</code>
*<code>ABS</code>: Returns the absolute of a number e.g. <code>ABS(-3)</code>
*<code>SIN</code>: Returns the sine of a number e.g. <code>SIN(3.14)</code>
*<code>COS</code>: Returns the cosine of a number e.g. <code>COS(3.14)</code>
*<code>TAN</code>: Returns the tangent of a number e.g. <code>TAN(3.14)</code>
*<code>LOG</code>: Returns the base 10 logarithm of a number e.g. <code>LOG(3)</code>
*<code>LOGN</code>: Returns the natural logarithm of a number e.g. <code>LOGN(4)</code>
*<code>MAX</code>: Returns the maximum of two numbers e.g. <code>MAX(4, 6)</code>
*<code>MIN</code>: Returns the minimum of two numbers e.g. <code>MIN(4, 6)</code>

Time series selected for the analysis can be added to the formula as variables either by entering the letter representing the time series manually or by double-clicking the time series in the list box.

The calculation only results in a number value for those timestamps that are common to all of the time series selected for analysis. If a timestamp is missing in one or more time series or the value of one or more time series is NaN for a timestamp, the resulting time series will have a NaN value for this particular timestamp.

Examples:
* <code>100</code> (without any variables):
: results in a time series with the value of 100 for each timestamp
* <code>A / 100</code> (where A is a time series):
: results in a time series where all values of A are divided by 100
* <code>A + B</code> (where A and B are time series):
: results in a time series where the values of A and B are added to together for each common timestamp
* <code>MAX(A, B)</code> (where A and B are time series):
: results in a time series with the maximum values from A and B
* <code>(2 * A) + LOG(B) - ABS(C) - 0.5</code> (where A, B and C are time series):
: complex calculation with multiple time series

Notes:
* Added in Wave v1.9.4
* The [https://www.codeproject.com/articles/274093/math-parser-net Math Parser .NET] library is used for parsing and evaluating the mathematical expression.

[[Category:BlueM.Wave|C]]
[[Category:Analysis functions|C]]

BlueM.Wave

2025-09-01T14:37:37Z

Froehlich: /* Known Issues */ Infinity values lost in TEN format, since v2.9.2

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
</gallery>

==Comandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* When saving a chart to the native TEN format of TeeChart, any Infinity values contained in the series are replaced by NaN values.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

BlueM.Wave

2025-09-01T14:36:16Z

Froehlich: /* Error values */ Infinity values in chart, since Wave v2.9.2, #199

{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]

==Description==
Wave is a tool for displaying, analyzing and importing and exporting time series.

==Features==

===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format_(BlueM)|BlueM.Sim result files]]: <code>*.WEL</code>, <code>*.KWL</code>
* [[DFS0-Format | DHI MIKE DFS0 format]]: <code>*.DFS0</code>
* [[WEL-Format (GISMO)|GISMO result files]]: <code>*.WEL</code>
* [[HYBNAT result files]]: <code>*.WEL</code>, <code>*.BCS</code>
* [[HYDRO_AS-2D result files]]: <code>*.DAT</code>
* [[Hystem-Extran file formats]]: Regendatei (<code>*.REG</code>, <code>*.DAT</code>) and Wellendatei (<code>*.WEL</code>)
* [[JAMS result files]]: JAMS/J2000/J2K/J2000g timeseries results (<code>*.DAT</code>)
* [[PRMS result files]]: annual summary, monthly summary, DPOUT (<code>*.OUT</code>) and statistic variables result file (<code>*.DAT</code>)
* [[SMUSI file formats]]: <code>*.ASC</code> result files and <code>*.REG</code> input files
* [[SWMM file formats]]: SWMM5 binary output format (<code>*.OUT</code>), routing interface files (<code>*.TXT</code>), LID report files (<code>*.TXT</code>), SWMM time series files (<code>*.DAT</code>)
* [[SMB-Format | SIMBA file format]]: <code>*.SMB</code>
* [[Talsim-NG file formats]]: time series results (<code>*.WEL</code>, <code>*.WBL</code>) and binary input time series (<code>*.BIN</code>)
* [[UVF-Format | UVF format]]: Universelles Variables Format (<code>*.UVF</code>)
* [[ZRE-Format | ZRE format]]: <code>*.ZRE</code>
* [[ZRXP-Format | ZRXP format]]: <code>*.ZRX</code>, <code>*.ZRXP</code>
* and [[CSV-Format|generic text files]] (e.g. <code>*.CSV</code>, <code>*.TXT</code>)

[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.WVP</code>) to quickly import multiple series from multiple files at once.

'''Drag&Drop''' files onto Wave to import them quickly.

It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].

===Visualization & Navigation===
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])

[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* [[File:Icon_controller.png|link=]] Use the '''navigation bar''' to set a custom display period and to navigate by a fixed time period or to the start/end [[File:Icons_navigate.png|link=]].
* [[File:Icon_table.png|link=]] Display tabular '''time series values''' and optionally show markers [[File:Icon_comments.png|link=]] for selected rows in the main chart

===Series management===
[[File:Wave TimeSeries Properties.png|thumb|right|Time series properties]]
* [[File:Icon_accept_split.png|link=]] Quickly switch time series on and off using the '''check boxes''' in the legend or activate/deactivate all series at once using the button in the toolbar.
* [[File:Icon_table_edit.png|link=]] Display and edit '''time series properties''' in a table with optional statistics.
* [[File:Icon_shape_align_bottom.png|link=]] '''Manage axes''': When importing time series, series are automatically assigned to different axes depending on their unit.

===Save & Export===
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.

[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).

[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.

'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM file formats|SWMM routing interface and time series files]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[UVF-Format | UVF]]
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]

===Edit & Analyze===
Editing functions:
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities

'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Accumulate|Accumulate]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualRecurrenceProbability|Annual recurrence probability]]: Annual recurrence probability of annual maxima using plotting position
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more time series
* [[Wave:ChangeTimestep|Change timestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Comparison|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Decumulate|Decumulate]]: Compute a new time series that consists of the decumulated values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:LinearRegression|Linear regression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit

<gallery mode="packed-hover">
File:Wave Cumulative.png|Accumulate|link=Wave:Accumulate
File:Wave Autocorrelation.png|Autocorrelation|link=Wave:Autocorrelation
File:Wave AnnualRecurrenceProbability.png|Annual recurrence probability|link=Wave:AnnualRecurrenceProbability
File:Wave AnnualStatistics BoundingBoxes.png|Annual statistics|link=Wave:AnnualStatistics
File:Wave Calculator.png|Calculator|link=Wave:Calculator
File:Wave ChangeTimestep Instantaneous.png|Change timestep
File:Wave Comparison.png|Comparison|link=Wave:ChangeTimestep
File:Wave Decumulate.png|Decumulate|link=Wave:Decumulate
File:Doppelsummenanalyse.png|Double sum curve|link=Wave:DoubleSumCurve
File:GoodnessOfFit ResultChart.png|Goodness of fit|link=Wave:GoodnessOfFit
File:Wave_Statistik.png|Histogram|link=Wave:Histogram
File:Wave LinearRegression.png|Linear regression|link=Wave:LinearRegression
File:Monatsauswertung.png|Monthly statistics|link=Wave:MonthlyStatistics
</gallery>

==Comandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.

==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.

See the API docs here: https://bluemodel.github.io/BlueM.Wave/api/

==Notes==
===Error values===
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
* Unreadable values are converted to NaN during file import.
* Infinity values are replaced by NaN for display in the chart.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* NaN values are displayed as gaps in the chart and are ignored when performing analysis functions.
* Custom, user-specified values can be converted to NaN [[File:Icon_error_convert.png|link=]] after import.
* NaN values can be visualized in the chart by pressing a [[File:Icon_chart_line_error.png|link=]] button (see screenshot).

===Volume property===
Wave calculates and displays the Volume property of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s", "/min", "/h" or "/d" (e.g. "m³/s", "mm/h", etc.) and its interpretation is either Instantaneous, BlockLeft or BlockRight, by integrating the values over time while respecting the interpretation. Time series with other units or interpretations only have the Sum property. NaN nodes cause the adjacent timesteps to not contribute to the volume (depends on the interpretation).

===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

==Downloads==
Download BlueM.Wave from GitHub: https://github.com/bluemodel/BlueM.Wave/releases/latest

==Known Issues==
* When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* <s>When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).</s> ''fixed in v1.9.1''
* more issues: https://github.com/bluemodel/BlueM.Wave/issues

==Development==
* [https://github.com/bluemodel/BlueM.Wave/blob/master/source/CHANGELOG.md Changelog]
* [[Wave:Development|Development]]

[[Category:BlueM.Wave]]

Template:Wave nav

2024-10-03T15:58:32Z

Froehlich: add download link

<div style="text-align:center; background-color:#E6B3EF; padding:2px; margin-bottom:5px; border:1px solid black;">
{{Wave Icon}} '''[[Wave]]''' | [https://github.com/bluemodel/BlueM.Wave/releases/latest Download] | [[Wave:Development|Development]]
</div>

Template:BlueM.Opt nav

2024-10-03T15:57:36Z

Froehlich: add download link

<div style="text-align:center; background-color:#CFFFD1; padding:2px; margin-bottom:5px; border:1px solid black;">
{{EVO Icon}} '''[[BlueM.Opt]]''' | [https://github.com/bluemodel/BlueM.Opt/releases/latest Download] | [[BlueM.Opt Usage|Usage]] | [[BlueM.Opt Development|Development]]
</div>

Template:BlueM.Sim nav

2024-10-03T15:56:29Z

Froehlich:

<div style="text-align:center; background-color:#CFE9FF; padding:2px; margin-bottom:5px; border:1px solid black;">
{{BlueM Icon}} '''[[BlueM.Sim]]''' | [https://bluemodel.org/download/ Download] | [[BlueM.Sim application|Application]] | [[BlueM.Sim theory|Theory]] | [[BlueM.Sim Development|Development]]
</div>

BlueM.Sim application

2024-10-03T15:53:31Z

Froehlich: fix download links

__NOTOC__
{{BlueM_nav}}
This page is an aid to the application of BlueM.

==Dataset==
* A BlueM.Sim dataset consists of several text files. The minimum requirements are an [[ALL-File]] - (general options) and a [[SYS-File]] - (System Plan). Furthermore, files for describing the different types of system elements must be included. All files must have the same filename (which is also the name of the dataset), only the file extensions differ. <small>(The name of the dataset should not be longer than 32 characters! ''See Bug 13'')</small>
* A QGIS plugin for creating BlueM.Sim input files, developed by Martin Grosshaus as part of his Master Thesis, is available on GitHub: https://github.com/bluemodel/BlueM.QGISInterface
* It is possible to create a dataset using [[TALSIM]], which can then be exported and used for BlueM.Sim. Minor modifications to the export files need to be carried out (see [[TALSIM Export]]).
''See also [[BlueM Eingabedateien|Input files]]''

==Simulation==
[[File:BlueMWin_screenshot.png|thumb|BlueM.Win Screenshot]]
===Releases starting from 0.9.1===
For individual simulations, it is easiest to use the '''[[BlueM.Win]]''' package.
* [https://bluemodel.org/download/ Download] the precompiled package <code>BlueM.Win.zip</code> and unzip.
* Start the program '''<code>BlueM.Win.exe</code>'''
* Select a dataset
* Start the simulation
* After successful simulation, view the simulation result in [[Wave]].

The computational core (<code>bluem.dll</code>) can be controlled using the API of the [[BlueM.DLLAdapter]].

====Using BlueM.Sim with OpenMI====
You need an OMI file, an example of which is provided below:
<source lang="xml">
<LinkableComponent Type="IHWB.BlueM.OpenMIAdapter.BlueM_LinkableComponent" Assembly="D:\BlueM\IHWB.BlueM.OpenMIAdapter.dll">
<Arguments>
<Argument Key="FilePath" ReadOnly="true" Value="D:\Dataset\demoNA" />
<Argument Key="AnzahlInterneZeitschritte" ReadOnly="true" Value="5" />
<Argument Key="Guetemodell" ReadOnly="true" Value="false" />
<Argument Key="Guetemodell_Abbauprozess" ReadOnly="true" Value="true" />
<Argument Key="Guetemodell_Dispersion" ReadOnly="true" Value="false" />
<Argument Key="Guetemodell_Merge" ReadOnly="true" Value="false" />
<Argument Key="Simulationsanfang" ReadOnly="true" Value="28.12.1967 00:00" />
</Arguments>
</LinkableComponent>
</source>

The directories have to be modified to point to the correct locations on your computer.

<u>Explanation of the argument keys:</u>

Location of the dataset (path and filename without ".ALL")
<source lang="xml"><Argument Key="FilePath" ReadOnly="true" Value="D:\Dataset\demoNA" /></source>

How many internal timesteps within one OpenMI timestep
<source lang="xml"><Argument Key="AnzahlInterneZeitschritte" ReadOnly="true" Value="5" /></source>

Use the water quality model ([[SWQM]])?
<source lang="xml"><Argument Key="Guetemodell" ReadOnly="true" Value="false" /></source>

Use degradation processes in the quality model ?
<source lang="xml"><Argument Key="Guetemodell_Abbauprozess" ReadOnly="true" Value="true" /></source>

No effect yet !
<source lang="xml">
<Argument Key="Guetemodell_Dispersion" ReadOnly="true" Value="false" />
<Argument Key="Guetemodell_Merge" ReadOnly="true" Value="false" />
</source>

Start date of the simulation:
<source lang="xml"><Argument Key="Simulationsanfang" ReadOnly="true" Value="28.12.1967 00:00" /></source>

===Release 0.9===
[[File:BlueMExe_screenshot.png|thumb|BlueM.exe Screenshot]]
* In the simplest case the compiled EXE file ([[BlueM Downloads|BlueM.exe]]) is in the same directory as the dataset to be simulated. In this case, simply launch the EXE and then enter the dataset name.
* You can specify the name of the dataset directly as a parameter to pass to BlueM.exe
:<pre class="dos">C:\WorkingDir>"path\to\BlueM.exe" datasetname</pre>
* To prevent the window from closing immediately when the simulation is finished or an error has occurred, a shortcut to BlueM.exe can be created. In the properties of the shortcut enter the following "target":
:<pre>cmd.exe /K "path\to\BlueM.exe"</pre>
:Also, specify the working directory as the directory in which the dataset is located.

==Results==
* Depending on the settings, BlueM.Sim creates different result files. By default, the main results are written to a [[WEL-File]].
''See also [[BlueM Ausgabedateien|output files]]''

===Errors / warnings===
* Errors cause the simulation to stop and must be remedied. All errors are logged to an [[ERR-File|*.ERR file]] in the dataset directory. The *.ERR file contains the date and time of the simulation in the filename and is preserved until deleted by the user. The error messages sometimes contain [[ERROR-Konstanten | error constants]].
* Warnings that occur during the simulation are also logged to a file ([[$WARN.TMP]]), which is deleted each time a new simulation is started.

[[Kategorie: BlueM.Sim Anwendung|A]]

BlueM.Sim

2024-10-03T15:52:11Z

Froehlich: fix download links

__NOTOC__
{{BlueM.Sim_nav}}
[[Bild:BlueMWin screenshot.png|thumb|Screenshot of [[BlueM.Win]] with [[Wave]]]]
==Description==
BlueM is a software package for river basin management. It allows for the integrated simulation of runoff and sediment transport processes in rural and urban areas, including the processes in water using physically based hydrological approaches. BlueM is a further development of model concepts, which for many years were pursued at [http://www.ihwb.tu-darmstadt.de IHWB] and have already been implemented in various applications.

==Downloads==
* [https://bluemodel.org/download/ Downloads]]

==Application==
* '''[[BlueM.Sim application|BlueM.Sim User Manual]]'''
** Documentation of the [[BlueM.Sim input files|input files]]
** Documentation of the [[BlueM.Sim output files | output files]]
* '''[[BlueM.Sim theory |BlueM.Sim Technical Manual]]''' (Theory)

==Development==
* [https://downloads.bluemodel.org/BlueM.Win/BLUEM.SIM_RELEASE-NOTES.txt RELEASE-NOTES]
* [[BlueM.Sim Development]]

[[Kategorie:BlueM.Sim|*]]

Template:BlueM.Sim nav

2024-10-03T15:50:40Z

Froehlich: fix download links

<div style="text-align:center; background-color:#CFE9FF; padding:2px; margin-bottom:5px; border:1px solid black;">
{{BlueM Icon}} '''[[BlueM.Sim]]''' | [https://bluemodel.org/download/ Download]] | [[BlueM.Sim application|Application]] | [[BlueM.Sim theory|Theory]] | [[BlueM.Sim Development|Development]]
</div>

Main Page

2024-10-03T15:49:40Z

Froehlich: fix download links

__NOEDITSECTION__
<big>'''Wiki for the BlueM software package'''</big>

<div style="background-color:#CFE9FF; border:1px solid #cccccc; padding:5px;">
==Description==
[[File:Ihwb-logo-athene.gif|right]]
BlueM is a software package for river basin management developed by the [http://bluemodel.org/ BlueM Dev Team] and the [http://www.ihwb.tu-darmstadt.de ihwb (Technische Universität Darmstadt)]. It allows for the integrated simulation, analysis and optimisation of discharge and pollution loads in rural and urban catchments, including processes in the water body, using physically-based hydrologic approaches. BlueM is the result of continuous development efforts based on model concepts that have been pursued at ihwb for many years and have already been implemented in various applications.

Besides the hydrological model core for rainfall-runoff computations including discharge, pollution load and water quality processes in rural and urban catchments ([[BlueM.Sim]]), the BlueM software package also contains tools for visualizing and analyzing time series ([[Wave|BlueM.Wave]]), for optimizing, auto-calibrating and performing sensitivity analyses on model parameters ([[BlueM.Opt]]), as well as for visualizing optimization results (e.g. in the form of scatterplot matrices). A further package component is [[BlueM.Analyser]], a tool for carrying out monitoring and assessment tasks in real-time (per time step).

BlueM.Sim and BlueM.Analyser are equipped with [http://www.openmi.org/ OpenMI-interfaces], which allows them to be coupled with other OpenMI-compliant models.

BlueM components:

* '''[[BlueM.Sim]]''' (hydrologic computational core – with OpenMI-interface)
* '''[[Wave|BlueM.Wave]]''' (time series management and analysis tool)
* '''[[BlueM.Opt]]''' (optimization based on evolutionary algorithms and sensitivity analysis)
* '''[[BlueM.Analyser]]''' (real-time data monitoring and evaluation tool – coupled via OpenMI)
* '''[[BlueM.MPC]]''' (model predictive control with BlueM.Opt and SWMM5)

The software package BlueM is freely available after registration. It is also possible to access the source code for research purposes (requires an agreement with [http://www.ihwb.tu-darmstadt.de ihwb]). Further information can be found in the [[BlueM License|License / Terms of Use]].

Publications about BlueM and projects in which BlueM was used are listed [[BlueM Referenzen|here]].
</div>

<div style="background-color:#CFFFD1; border:1px solid #cccccc; padding:5px; margin-top:10px;">
==Documentation==
:{{BlueM Icon}} '''[[BlueM.Sim]]: Continuous rainfall-runoff and reservoir simulation model'''
::[https://bluemodel.org/download/ Download]] | [[BlueM.Sim application|Usage]] | [[BlueM Theorie Index|Theory]] | [[BlueM.Sim Development|Development]]

:{{EVO Icon}} '''[[BlueM.Opt]]: Optimization Framework'''
::[https://github.com/bluemodel/BlueM.Opt/releases/latest Download] | [[BlueM.Opt Anwendung|Usage]] | [[BlueM.Opt Development|Development]]

:{{Wave Icon}} '''[[BlueM.Wave]]: Tool for displaying and analysing time series'''
::[https://github.com/bluemodel/BlueM.Wave/releases/latest Download] | [[Wave:Development|Development]]
</div>

<div style="background-color:#f1f1f1; border:1px solid #cccccc; padding:5px; margin-top:10px;">
==[[BlueM:Current events|Current events]]==
<div style="height:200px; overflow:auto; border:1px dotted black; padding:0 10px 10px 5px; margin:10px;">{{:BlueM:Current events}}</div>
</div>

<div style="background-color:#FEFFBF; border:1px solid #cccccc; padding:5px; margin-top:10px;">
==Help==
This wiki contains detailed descriptions of the application and of the theory behind the individual software components.

Additional resources:
* [[Help:Contents|Help]] for dealing with the wiki
* [[FAQ|Frequently Asked Questions (FAQ)]]
</div>

<div style="background-color:#FFDFDF; border:1px solid #cccccc; padding:5px; margin-top:10px;">
==Collaboration==
All visitors to this site are invited to use and improve upon the projects!
* The '''documentation''' in this Wiki - for editing the wiki you need a [http://wiki.bluemodel.org/index.php?title=Special:UserLogin&type=signup&returnto=Main_Page user account].
* The '''source code'''. Source code and issues are managed on [https://github.com/bluemodel/ GitHub]. [https://bluemodel.org/contact/ Contact us] for inquiries.
</div>

BlueM.Sim compilation

2024-03-02T12:46:35Z

Froehlich: mention Intel Fortran Compiler Extension for Visual Studio

{{BlueM.Sim nav}}
<div style="float:right; margin:0 0 10px 10px;">__TOC__</div>

==Compilation==
BlueM.Sim is written in FORTRAN. Additional components such as [[BlueM.DLLAdapter]] and [[BlueM.Wave]] are written in C# and VB.NET, while [[BlueM.LaPipe]] is written in C++.

Recommended software setup for compiling BlueM.Sim:
* [https://visualstudio.microsoft.com/ Microsoft Visual Studio 2019 or 2022] (Community Edition is sufficient)
** Select at least the "Desktop Development with C++" component
* Intel Fortran Compiler:
** [https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit-download.html Intel oneAPI Base Toolkit], select at a minimum "Intel Distribution for GDB". This provides the Fortran debugger support for Visual Studio.
** [https://www.intel.com/content/www/us/en/developer/tools/oneapi/hpc-toolkit-download.html Intel oneAPI HPC Toolkit], select at a minimum "Intel Fortran Compiler".
:Or, use the new Intel Fortran Compiler Extension for Visual Studio: https://marketplace.visualstudio.com/items?itemName=intel-corporation.fortranonline

Further reading:
* [https://www.intel.com/content/www/us/en/developer/articles/guide/installing-microsoft-visual-studio-2019-for-use-with-intel-compilers.html Installing Microsoft Visual Studio* for Use with Intel® Compilers]
* [https://www.intel.com/content/www/us/en/developer/articles/training/intel-fortran-compiler-in-ms-visual-studio.html How to Select oneAPI Intel® Fortran Compiler and Compiler Version in Microsoft* Visual Studio]

==Compiler settings==
[[Bild:RECLinBytes.jpg|thumb|Use Bytes as RECL]]
Required compiler settings (''Flags''):
* <code>/assume:byterecl</code>
: This causes Intel Fortran to interpret the record length of unformatted files (e.g. time series in [[BIN-Format]]) in bytes instead of in 4 byte units (longwords). This flag is set by setting ''Use Bytes as RECL unit for unformatted files:'' to '''Yes''' (see image).
The compiler settings are stored in the project file <code>BlueM.Sim.vfproj</code> and normally do not have to be adjusted.

==Build configurations==
The following build configurations for BlueM.Sim are defined in the project file:
* '''Debug''': Debug version, no optimizations
* '''Release''': Release version with optimizations

[[Kategorie:BlueM.Sim Development]]

Template:BlueM.Opt nav

2024-02-11T18:33:48Z

Froehlich: remove download link from navigation

<div style="text-align:center; background-color:#CFFFD1; padding:2px; margin-bottom:5px; border:1px solid black;">
{{EVO Icon}} '''[[BlueM.Opt]]''' | [[BlueM.Opt Usage|Usage]] | [[BlueM.Opt Development|Development]]
</div>

BlueM.Opt

2024-02-11T18:33:11Z

Froehlich: /* Downloads */ Update download locations

__NOTOC__
{{BlueM.Opt_nav}}
[[File:Simulation-based-optimization.png|thumb|Simulation-based optimization]]
[[File:EVO Box screenshot.png|thumb|Screenshot]]
[[File:Scatterplot screenshot.png|thumb|Scatterplot Matrix]]
==Description==
BlueM.Opt is an optimization framework that can be coupled with an arbitrary simulation software (only current requirement: input data and results are to be stored in ASCII format). The optimization parameters, objective functions and (optionally) contraints can be defined in a flexible manner.

Optimization results are stored in a [[BlueM.Opt output files|database]].

BlueM.Opt integrates a graphing feature for displaying the optimization progress and results. Optimization results can also be analyzed in detail.

Where possible, BlueM.Opt utilizes multithreading in order to evaluate multiple parameter sets simultaneously.

List of currently implemented applications (simulation models):
* '''[[BlueM.Sim]]'''
* '''[[TALSIM|Talsim-NG]]'''
* '''<del>[[SMUSI]]</del>''' (''currently not included [https://github.com/bluemodel/BlueM.Opt/issues/184 #184]'')
* '''[[SWMM]]'''
* '''[[Test problems]]'''
* '''[[Traveling Salesman]]'''

List of available methods (optimization algorithms):
* '''[[PES]]''': Parametric Evolution Strategy
* '''[[Hooke & Jeeves]]''': Hillclimbing Algorithm
* '''[[MetaEvo]]''': multicritera, hybrid optimization algorithm
* '''[[DDS]]''': Dynamically Dimensioned Search
other included methods are
* '''[[SensiPlot]]''': Sensitivity analysis (no optimization)
* '''[[TSP]]''' (only for [[Traveling Salesman]])

==Downloads==
Download BlueM.Opt from GitHub: https://github.com/bluemodel/BlueM.Opt/releases/latest

==Usage==
* '''[[BlueM.Opt Usage]]'''
** Documentation of the [[BlueM.Opt input files| input files]]
** Documentation of the [[BlueM.Opt output files| output files]]

==Literature==
* {{:Literatur:Muschalla 2006}}
* {{:Literatur:Muschalla 2008}}
* {{:Literatur:Muschalla et al. 2009}}
* {{:Literatur:Kerber_2009}}
* {{:Literatur:Froehlich & Hübner 2009}}

==Development==
* [[BlueM.Opt Development]]
** [[BlueM.Opt Begriffsklärung | Glossary]]
** Documentation of the [[BlueM.Opt Code|code]]

==Literature==
<references/>

[[Category:BlueM.Opt]]

BlueM.Opt Development

2024-02-11T18:12:14Z

Froehlich: restructure

{{BlueM.Opt_nav}}
<div style="float:right; margin-left:10px;">__TOC__</div>

==Source code==
BlueM.Opt is written in VB.NET and C#. The source code and issues are managed on GitHub: https://github.com/bluemodel/BlueM.Opt

[[BlueM.Sim]] and [[BlueM.DLLAdapter]] as well as [[TALSIM|Talsim-NG]] and [[SWMM]] are included in the repository as precompiled binaries, and [[BlueM.Wave]] is included as a submodule.

==Compilation==
When compiling BlueM.Opt, a [https://www.steema.com/product/net TeeChart .NET] Pro license is required.

For testing purposes, you can use the evaluation version of TeeChart by removing the files <code>My Project\TeeChart.licenses</code> from the project within Visual Studio or by adding a files in their place. This will allow you to compile, but any charts will be displayed with a watermark.

<div class="info">
'''Note:'''

BlueM.Wave is set up to be output to a subdirectory <code>BlueM.Wave</code>. For this to work, the following settings have been made:
* set <code><probing privatePath="BlueM.Wave"/></code> in <code>app.config</code>
* set the "Copy Local" property of all project references to Wave to False (corresponds to <code><Private>False</Private></code> in the project files).
* the main Wave assembly output is copied to the subdirectory in the post-build event
* additional assemblies used by Wave that are unfortunately automatically output to the main output folder (no idea why?) are moved to the subdirectory individually, also in the post-build event

This could probably be done better, but that's the way it is right now.
</div>

===Documentation===
* [[BlueM.Opt Code|Code]]
* [[BlueM.Opt Multithreading|Multithreading]]
* [[BlueM.Opt Monitor|Monitor]]
* [[BlueM.Opt Evaluierung|Evaluation]]

[[Kategorie:BlueM.Opt Development]]

BlueM.Opt Development

2024-02-11T18:10:23Z

Froehlich: update and add some explanations

{{BlueM.Opt_nav}}
<div style="float:right; margin-left:10px;">__TOC__</div>

==Source code==
BlueM.Opt is written in VB.NET and C#. The source code and issues are managed on GitHub: https://github.com/bluemodel/BlueM.Opt

[[BlueM.Sim]] and [[BlueM.DLLAdapter]] as well as [[TALSIM|Talsim-NG]] and [[SWMM]] are included in the repository as precompiled binaries, and [[BlueM.Wave]] is included as a submodule.

When compiling BlueM.Opt and BlueM.Wave, a [https://www.steema.com/product/net TeeChart .NET] Pro license is required.

For testing purposes, you can use the evaluation version of TeeChart by removing the file <code>My Project\TeeChart.licenses</code> from the project within Visual Studio or by adding an empty file in its place. This will allow you to compile, but any charts will be displayed with a watermark.

==Compilation==
To compile, open the solution file <code>BlueM.Opt.sln</code> in Visual Studio and just build it.

<div class="info">
'''Note:'''

BlueM.Wave is set up to be output to a subdirectory <code>BlueM.Wave</code>. For this to work, the following settings have been made:
* set <code><probing privatePath="BlueM.Wave"/></code> in <code>app.config</code>
* set the "Copy Local" property of all project references to Wave to False (corresponds to <code><Private>False</Private></code> in the project files).
* the main Wave assembly output is copied to the subdirectory in the post-build event
* additional assemblies used by Wave that are unfortunately automatically output to the main output folder (no idea why?) are moved to the subdirectory individually, also in the post-build event

This could probably be done better, but that's the way it is right now.
</div>

===Documentation===
* [[BlueM.Opt Code|Code]]
* [[BlueM.Opt Multithreading|Multithreading]]
* [[BlueM.Opt Monitor|Monitor]]
* [[BlueM.Opt Evaluierung|Evaluation]]

[[Kategorie:BlueM.Opt Development]]