Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
tseries:technical [2014-01-22 07:33:08] juergens |
tseries:technical [2022-05-31 09:29:32] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Tseries Technical Documentation ====== | ====== Tseries Technical Documentation ====== | ||
- | |||
- | [[https:// | ||
- | |||
- | [[diana: | ||
===== Description: | ===== Description: | ||
- | //Tseries// is an open-source time-series viewer for meteorological purposes. //Tseries// is developed and implemented at the Norwegian Meteorological Institute met.no, as a part of the operational meteorological workstation. //Tseries// can be used standalone, or in interaction with the DIANA meteorological workstation. | + | //Tseries// is an open-source time-series viewer for meteorological purposes. //Tseries// is developed and implemented at the Norwegian Meteorological Institute met.no, as a part of the operational meteorological workstation. //Tseries// can be used standalone, or in interaction with the [[https:// |
The //Tseries// package contains two programs: | The //Tseries// package contains two programs: | ||
Line 18: | Line 14: | ||
+ | Styles and control are located in a separate package - The source code is downloadable at [[https:// | ||
===== Command line parameters: ===== | ===== Command line parameters: ===== | ||
Most of the input in //Tseries// is given by the control file, but can be overridden by command line input: | Most of the input in //Tseries// is given by the control file, but can be overridden by command line input: | ||
+ | | | ||
| **-s [ setupfile ]** | if the setup file is not directly defined or invalid, //Tseries// will try to find a valid setup file with the name tseries.ctl in the system. First looking in the current directory, then in $HOME/ | | **-s [ setupfile ]** | if the setup file is not directly defined or invalid, //Tseries// will try to find a valid setup file with the name tseries.ctl in the system. First looking in the current directory, then in $HOME/ | ||
| **-S [site]** | site is just a short string. The user can define elements in the setup-file that are only used by certain groups. By this, several groups of users can share one setup-file to simplify maintenance. | | **-S [site]** | site is just a short string. The user can define elements in the setup-file that are only used by certain groups. By this, several groups of users can share one setup-file to simplify maintenance. | ||
Line 44: | Line 40: | ||
- **KDVH** is a MET Norway proprietary interface, based on URL. KDVH reads observations from the Norwegian climatic database. The Data are defined as Diagram entries in the control file (tseries.ctl) and can be implemented in any diagram. | - **KDVH** is a MET Norway proprietary interface, based on URL. KDVH reads observations from the Norwegian climatic database. The Data are defined as Diagram entries in the control file (tseries.ctl) and can be implemented in any diagram. | ||
- | - **Fimex** | + | - **Fimex** |
===== Diagrams: ===== | ===== Diagrams: ===== | ||
Line 105: | Line 101: | ||
| **Images** | Path to find images used in diagrams, like weather symbols | | | **Images** | Path to find images used in diagrams, like weather symbols | | ||
| **Lang** | | **Lang** | ||
+ | | **Styles** | Path to find stylefiles in tsDiagrams.def | | ||
Line 110: | Line 107: | ||
^ Token ^ Description ^ | ^ Token ^ Description ^ | ||
- | | **Defs** | + | | **Defs** |
| **Configure** | Autogenerated File to store configuration (like window size, language etc) from the GUI. | | | **Configure** | Autogenerated File to store configuration (like window size, language etc) from the GUI. | | ||
| **WeatherSymbols** | The weather symbol definition file | | | **WeatherSymbols** | The weather symbol definition file | | ||
- | | **stdImage** | + | | **stdImage** |
- | | **finImage** | + | | **finImage** |
| **iconImage** | | **iconImage** | ||
| **baseFilter** | | **baseFilter** | ||
| **wdbBookmarks** | | **wdbBookmarks** | ||
- | | **fimexBookmarks** | + | | **fimexBookmarks** |
| **commonBookmarks** | A file with common bookmarks, valid for all users | | | **commonBookmarks** | A file with common bookmarks, valid for all users | | ||
=== SECTION: < | === SECTION: < | ||
^ Token ^ Description ^ | ^ Token ^ Description ^ | ||
- | | **FimexStreamTypes** | List of streamtypes that willbe | + | | **FimexStreamTypes** | List of streamtypes that will be read by [[fimex: |
+ | |||
+ | |||
+ | === SECTION: <WDB> === | ||
+ | ^ Token ^ Description ^ | ||
+ | | **Host** | ||
+ | | **User** | ||
+ | | **busymovie** | Animated gif to display that the server is busy - caching | | ||
+ | | **readtime** | ||
+ | | **maxRecord **| Cutoff for records in bookmarks | | ||
+ | |||
+ | |||
+ | |||
+ | === SECTION: < | ||
+ | ^ Token ^ Description ^ | ||
+ | | **url** | base URL for the klima requequest | | ||
+ | | **maxDistance** | max distance to an observation in km (default=50) | | ||
+ | | **maxObservationLength** | how many hours to look into the past (default=300) | | ||
+ | |||
=== SECTION: < | === SECTION: < | ||
- | The server section is used to define the connection to diana via coserver | + | The server section is used to define the connection to [[https://diana.wiki.met.no/ |
^ Token ^ Description ^ | ^ Token ^ Description ^ | ||
- | | **Client** | + | | **Client** |
| **Name** | | **Name** | ||
| **Command** | Command to start coserver | | | **Command** | Command to start coserver | | ||
Line 138: | Line 154: | ||
The streams section is parsed by an older system, the pets graphical engine, on which | The streams section is parsed by an older system, the pets graphical engine, on which | ||
//Tseries// is build. | //Tseries// is build. | ||
- | All data input from HDF files and [[Https:// | + | All data input from HDF files and [[fimex:start|Fimex]] |
A new model starts with a collection name, this is kept for backwards-compatibility, | A new model starts with a collection name, this is kept for backwards-compatibility, | ||
Line 150: | Line 166: | ||
In a collection, any hdf/fimex file has to be registered the following way | In a collection, any hdf/fimex file has to be registered the following way | ||
- | == A HDF/ | + | == A HDF/ |
^ Token ^ Description ^ | ^ Token ^ Description ^ | ||
- | | **DataFile** | + | | **DataFile** |
- | | **DataDescription** | The data description. A hdf file can contain several streams. You have to find the exact stream name in the file (when in doubt use vshow). The data description is used to define values in the diagram definition. (tsDiagrams.def) | | + | | **DataDescription** | The data description. A hdf file can contain several streams. You have to find the exact stream name in the file (when in doubt use vshow). The data description is used to define values in the diagram definition. (tsDiagrams.def) | |
| **DataType** | HDF or ASCII | | | **DataType** | HDF or ASCII | | ||
| **Contents** | What parameter are defined in the file, x means any. The string is separated into four sections: Parameter, | | **Contents** | What parameter are defined in the file, x means any. The string is separated into four sections: Parameter, | ||
- | == A FIMEX stream | + | == A FIMEX Stream |
^ Token ^ Description ^ | ^ Token ^ Description ^ | ||
- | | **DataFile** | + | | **DataFile** |
- | | **DataDescription** | The data description. Just a string to connect this stream to the diagram definition. (tsDiagrams.def) | | + | | **DataDescription** | The data description. Just a string to connect this stream to the diagram definition. (tsDiagrams.def) |
| **DataType** | [ type : tag ] type has to be defined in fimexStreamTypes, | | **DataType** | [ type : tag ] type has to be defined in fimexStreamTypes, | ||
- | | **Contents** | Not really used in Fimexstreams | | + | | **Contents** | Not really used in Fimexstreams |
- | | **DataConfig** | Connect a [[https:// | + | | **DataConfig** | Connect a [[fimex:start|Fimex]] |
+ | === SECTION: < | ||
+ | This section maps wdb parameters to tseries parameters | ||
+ | < | ||
+ | # tseries parameter | ||
+ | MSLP, | ||
+ | RR, | ||
+ | TT, | ||
+ | UU, | ||
+ | </ | ||
+ | === SECTION:< | ||
+ | connect two parameters to a vector( to rotate them into a greografic grid) | ||
+ | < | ||
+ | UU,0,x,x,x :VV,0,x,x,x | ||
+ | </ | ||
+ | === SECTION: < | ||
+ | |||
+ | < | ||
+ | # tseries parameter = klimaparameter | ||
+ | TT_O, | ||
+ | MSLP_O, | ||
+ | QNH_O, | ||
+ | |||
+ | </ | ||
+ | |||
+ | === SECTION: < | ||
+ | < | ||
+ | # tseries parameter = klimaparameter | ||
+ | # for these parameters, tseries has to build a timeline | ||
+ | TAM, | ||
+ | TANM, | ||
+ | TAXM, | ||
+ | </ | ||
+ | |||
+ | === SECTION: < | ||
+ | |||
+ | |||
+ | |||
+ | < | ||
+ | |||
+ | tag = Given at the fimexstream definition | ||
+ | fimexname = Request parametername | ||
+ | Unit = Udunits string | ||
+ | extradim | ||
+ | be defined her for this particular parameter | ||
+ | |||
+ | # tseries parameter | ||
+ | # | ||
+ | # | ||
+ | |||
+ | |||
+ | MSLP,x,x,x = netcdf | air_pressure_at_sea_level | ||
+ | TT, | ||
+ | UU, | ||
+ | |||
+ | # with a defined RRAC, tseries knows automatically how to extract RR from it | ||
+ | RRAC,x,x,x = netcdf | precipitation_amount_acc | ||
+ | # Postprocessed temperature - alias... | ||
+ | TTPP,x,x,x = netcdf | air_temperature_2m | ||
+ | |||
+ | ## Wrf data | ||
+ | |||
+ | MSLP,x,x,x = wrf | air_pressure_at_sea_level | ||
+ | TT, | ||
+ | UU, | ||
+ | VV, | ||
+ | |||
+ | </ | ||
Line 184: | Line 267: | ||
===The [models] section=== | ===The [models] section=== | ||
- | Any model have to be defined in the models section, | + | All Models |
+ | |||
+ | Example: | ||
< | < | ||
| | ||
</ | </ | ||
- | ECMWF is the DataDescription from tseries.ctl, | + | ECMWF equals |
Line 204: | Line 289: | ||
NAME=Meteogram | NAME=Meteogram | ||
# The connected style file | # The connected style file | ||
- | STYLEFILE=/ | + | STYLEFILE=meteogram.style |
# The streams connected to this diagram | # The streams connected to this diagram | ||
[LEGALMODELS] | [LEGALMODELS] | ||
Line 210: | Line 295: | ||
MODEL=HARMONIE_2.5km | MODEL=HARMONIE_2.5km | ||
- | # modelindependent means, that these parameters will be taken from # all models, if available | + | # Modelindependent = These parameters will be taken from |
+ | # all models, if available | ||
[MODELINDEPENDENT] | [MODELINDEPENDENT] | ||
PARAM=UU, | PARAM=UU, | ||
Line 218: | Line 305: | ||
[END] | [END] | ||
- | # modelspecific means that these parameters are only used if they # come from the specified model. | + | # Modelspecific = These parameters are only used if they come from the specified model. |
- | # modflspecifi | + | # Modelspecific |
# If they are not defined there, they will not occur in the menu | # If they are not defined there, they will not occur in the menu | ||
Line 235: | Line 322: | ||
</ | </ | ||
- | Styles | + | ====Styles==== |
Styles are defined in stylefiles. These are connected to data by tsDiagrams.def. | Styles are defined in stylefiles. These are connected to data by tsDiagrams.def. | ||
By altering the stylesfiles you can control colors, line and object types in the diagram. | By altering the stylesfiles you can control colors, line and object types in the diagram. | ||
There are hundreds of different types in a stylefile. | There are hundreds of different types in a stylefile. | ||
+ | |||
+ | < | ||
# | # | ||
# | # | ||
Line 298: | Line 387: | ||
[DEFAULT] | [DEFAULT] | ||
+ | </ | ||
Then you have to define axes | Then you have to define axes | ||
+ | < | ||
first at least one x-axis | first at least one x-axis | ||
# -------------------------------- | # -------------------------------- | ||
Line 313: | Line 404: | ||
minSkipX= 15 | minSkipX= 15 | ||
[ADD] | [ADD] | ||
+ | |||
+ | </ | ||
And then several y-axes. A curve in the diagram is connected to an axis. If you want to display, for instance several temperatures, | And then several y-axes. A curve in the diagram is connected to an axis. If you want to display, for instance several temperatures, | ||
+ | |||
+ | < | ||
# ---------------------------- | # ---------------------------- | ||
# Yaxis (T2m) | # Yaxis (T2m) | ||
Line 336: | Line 431: | ||
patternInColour=TRUE | patternInColour=TRUE | ||
[ADD] | [ADD] | ||
+ | </ | ||
With axis in place, you have to define a parameter and connect it to it. In this case, the curve is presented in 2 different colors, one for -100 to 0 degrees and one for 0-100 degrees. | With axis in place, you have to define a parameter and connect it to it. In this case, the curve is presented in 2 different colors, one for -100 to 0 degrees and one for 0-100 degrees. | ||
+ | < | ||
[NEW] | [NEW] | ||
type= LINE | type= LINE | ||
Line 353: | Line 449: | ||
patternInColour= FALSE | patternInColour= FALSE | ||
[ADD] | [ADD] | ||
+ | </ | ||
- | + | ===Valid Types:=== | |
- | Valid types: | + | |
There are several types in //Tseries// that can be used by the different elements. | There are several types in //Tseries// that can be used by the different elements. | ||
- | Colors: | ||
- | BLACK | ||
- | BLUE | ||
- | GREEN | ||
- | CYAN | ||
- | RED | ||
- | MAGENTA | ||
- | YELLOW | ||
- | WHITE | ||
- | GREY25 | ||
- | GREY40 | ||
- | GREY45 | ||
- | GREY50 | ||
- | GREY55 | ||
- | GREY60 | ||
- | GREY65 | ||
- | GREY70 | ||
- | GREY75 | ||
- | GREY80 | ||
- | GREY85 | ||
- | GREY90 | ||
- | GREY95 | ||
- | MIST_RED | ||
- | MIST_GREEN | ||
- | MIST_BLUE | ||
- | DARK_GREEN | ||
- | BROWN | ||
- | ORANGE | ||
- | PURPLE | ||
- | LIGHT_BLUE | ||
- | DARK_YELLOW | ||
- | DARK_RED | ||
- | DARK_BLUE | ||
- | DARK_CYAN | ||
- | DARK_MAGENTA | ||
- | MIDNIGHT_BLUE | ||
- | DNMI_GREEN | ||
- | DNMI_BLUE | ||
- | RUST_RED | ||
- | DAWN_RED | ||
- | SUN_YELLOW | ||
- | SPRING_GREEN | ||
- | IRR_GREEN | ||
- | MOSS_GREEN | ||
- | GRASS_GREEN | ||
- | THUNDER_GREY | ||
- | SEA_BLUE | ||
- | SKY_BLUE | ||
- | ICE_BLUE | ||
- | GLACIER_WHITE | ||
- | RAIN_GREY | ||
- | IVORY | ||
- | DARK_IVORY | ||
- | BLUEGREY | ||
- | GREYBROWN | ||
- | OLIVE | ||
- | MUDDYGREEN | ||
- | GREYBLUE | ||
- | DARK_BLUEGREY | ||
- | DARKOLIVE | ||
- | RED_YELLOW | ||
- | YELLOW_RED | ||
- | Fillpatterns | + | ====Colors==== |
- | DIAGRIGHT | + | |
- | DIAGLEFT | + | {{: |
- | DIAGCROSS | + | |
- | HORIZONTAL | + | |
- | VERTICAL | + | |
- | SHORIZONTAL | + | ^ Fillpatterns |
- | SVERTICAL | + | | DIAGRIGHT |
- | SQUARE | + | | DIAGLEFT |
- | SOLID | + | | DIAGCROSS |
- | Linestyle | + | | HORIZONTAL |
- | DASHED | + | | VERTICAL |
- | DASHDOTTED | + | | SHORIZONTAL |
- | DASHDASHDOTTED | + | | SVERTICAL |
- | DOTTED | + | | SQUARE |
+ | | SOLID | ||
+ | |||
+ | |||
+ | ^ Linestyle | ||
+ | | DASHED | ||
+ | | DASHDOTTED | ||
+ | | DASHDASHDOTTED | ||
+ | | DOTTED | ||
+ | |||
+ |