ZRXP-Format: Difference between revisions

From BlueM
Jump to navigation Jump to search
(added ensemble forecast layout (since Wave v2.3.0))
(→‎Notes: Metadata keys)
 
Line 48: Line 48:
==Notes==
==Notes==
* The ZRXP format is associated with the file extensions <code>*.zrx</code> and <code>*.zrxp</code>.
* The ZRXP format is associated with the file extensions <code>*.zrx</code> and <code>*.zrxp</code>.
* Wave reads all metadata contained in the file, but currently only uses <code>CUNIT</code> for setting the unit, a combination of <code>SNAME</code> and <code>CNAME</code> for setting the title, and <code>RINVAL</code> for handling error values.  
* Wave can read and write the following header entries, which are all handled as metadata:
** <code>ZRXPVERSION</code>
** <code>ZRXPMODE</code>
** <code>ZRXPCREATOR</code>
** <code>REXCHANGE</code>
** <code>TZ</code>
** <code>SANR</code>
** <code>SNAME</code>
** <code>SWATER</code>
** <code>CNR</code>
** <code>CNAME</code>
** <code>CTYPE</code>
** <code>CMW</code>
** <code>RTIMELVL</code>
** <code>CUNIT</code>
** <code>RINVAL</code>
** <code>RNR</code>
** <code>RTYPE</code>
** <code>RORPR</code>
** <code>LAYOUT</code>
* From the above list, Wave uses the value of <code>CUNIT</code> for setting the unit, a combination of <code>SNAME</code> and <code>CNAME</code> for setting the title, and <code>RINVAL</code> for handling error values.  


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

Latest revision as of 05:02, 20 October 2023

Wave.png Wave | Download | Development

The ZRXP format is a text-based format for time series developed by Kisters.

The format is documented in Data Exchange Format ZRXP, User Manual information.png (German version information.png).

Example file:

#ZRXPVERSION2206.235|*|ZRXPMODEStandard|*|ZRXPCREATORKisters ZRXP-Fileexporter|*|
#TZMEZ|*|SANR00001234|*|SNAMEStation|*|SWATERFluss|*|CNR12345|*|CNAMEQzu|*|
#CTYPEn-min-equi|*|CMW1|*|RTIMELVLdaily|*|CUNITm3/s|*|RINVAL-777|*|RNR1|*|
#RTYPEmean values|*|RORPRProduktion|*|
#LAYOUT(timestamp,value)|*|
19741231000000 -777.0 
19750101000000 3.23 
19750102000000 2.69 
19750103000000 2.51 
19750104000000 2.20 
19750105000000 1.79 
19750106000000 1.54 
19750107000000 2.48 

Different layouts are supported by Wave:

  • LAYOUT(timestamp,value): the simplest layout, as shown in the example above, consists of only timestamps and values for a single time series.
  • LAYOUT(timestamp,value,remark): this layout allows for an optional text remark for each node. Such remarks are ignored by Wave during import.
  • LAYOUT(timestamp,forecast,member,value): this layout is used for ensemble forecasts consisting of multiple time series with different initialization dates and member numbers. The first column "timestamp" is considered the forecast initialization date and the second column "forecast" is considered the forecast valid date. Example:
##Ensemble seasonal forecast
#ZRXPVERSION3014.03|*|ZRXPCREATORSYDRO pyTimeseries|*|
#SANR10|*|SNAMEExample|*|
#CNAMESeasonal forecast|*|CUNIT---|*|RINVAL-777.0|*|
#LAYOUT(timestamp,forecast,member,value,)|*|
20220901000000 20220901000000 1 -2.361538799802739
20220901000000 20221001000000 1 -2.4925870318685766
20220901000000 20221101000000 1 -1.7288213420732492
20220901000000 20221201000000 1 -1.4400402417182527
20220901000000 20230101000000 1 -0.9092383266664021
20220901000000 20230201000000 1 -1.7735326838180545
20220901000000 20220901000000 2 -1.8020267517568571
20220901000000 20221001000000 2 -2.034995017608184
20220901000000 20221101000000 2 -1.0236442939234867
20220901000000 20221201000000 2 -1.062878089184713
20220901000000 20230101000000 2 -0.2841003313570293
20220901000000 20230201000000 2 -0.1492832315302455

Notes

  • The ZRXP format is associated with the file extensions *.zrx and *.zrxp.
  • Wave can read and write the following header entries, which are all handled as metadata:
    • ZRXPVERSION
    • ZRXPMODE
    • ZRXPCREATOR
    • REXCHANGE
    • TZ
    • SANR
    • SNAME
    • SWATER
    • CNR
    • CNAME
    • CTYPE
    • CMW
    • RTIMELVL
    • CUNIT
    • RINVAL
    • RNR
    • RTYPE
    • RORPR
    • LAYOUT
  • From the above list, Wave uses the value of CUNIT for setting the unit, a combination of SNAME and CNAME for setting the title, and RINVAL for handling error values.