WSL/SLF GitLab Repository

Commit c6b23a21 authored by Mathias Bavay's avatar Mathias Bavay
Browse files

A new drawing has been integrated into the documentation.

parent 13dbf163
#FIG 3.2 Produced by xfig version 3.2.5b
Landscape
Center
Metric
A4
80.00
Single
-2
1200 2
0 32 #c6b797
0 33 #eff8ff
0 34 #dccba6
0 35 #404040
0 36 #808080
0 37 #c0c0c0
0 38 #e0e0e0
0 39 #8e8f8e
0 40 #aaaaaa
0 41 #555555
0 42 #c7c3c7
0 43 #565151
0 44 #8e8e8e
0 45 #d7d7d7
0 46 #85807d
0 47 #d2d2d2
0 48 #3a3a3a
0 49 #4573aa
0 50 #aeaeae
0 51 #7b79a5
0 52 #444444
0 53 #73758c
0 54 #f7f7f7
0 55 #414541
0 56 #635dce
0 57 #bebebe
0 58 #515151
0 59 #e7e3e7
0 60 #000049
0 61 #797979
0 62 #303430
0 63 #414141
0 64 #c7b696
0 65 #dd9d93
0 66 #f1ece0
0 67 #c3c3c3
0 68 #e2c8a8
0 69 #e1e1e1
0 70 #ededed
0 71 #da7a1a
0 72 #f1e41a
0 73 #887dc2
0 74 #b0a193
0 75 #837cdd
0 76 #d6d6d6
0 77 #8c8ca5
0 78 #4a4a4a
0 79 #8c6b6b
0 80 #5a5a5a
0 81 #636363
0 82 #b79b73
0 83 #4193ff
0 84 #bf703b
0 85 #db7700
0 86 #dab800
0 87 #006400
0 88 #5a6b3b
0 89 #d3d3d3
0 90 #8e8ea4
0 91 #f3b95d
0 92 #89996b
0 93 #646464
0 94 #b7e6ff
0 95 #86c0ec
0 96 #bdbdbd
0 97 #d39552
0 98 #98d2fe
0 99 #8c9c6b
0 100 #f76b00
0 101 #5a6b39
0 102 #8c9c6b
0 103 #8c9c7b
0 104 #184a18
0 105 #adadad
0 106 #f7bd5a
0 107 #636b9c
0 108 #de0000
0 109 #adadad
0 110 #f7bd5a
0 111 #adadad
0 112 #f7bd5a
0 113 #636b9c
0 114 #526b29
0 115 #949494
0 116 #006300
0 117 #00634a
0 118 #7b844a
0 119 #e7bd7b
0 120 #a5b5c6
0 121 #6b6b94
0 122 #846b6b
0 123 #529c4a
0 124 #d6e7e7
0 125 #526363
0 126 #186b4a
0 127 #9ca5b5
0 128 #ff9400
0 129 #ff9400
0 130 #00634a
0 131 #7b844a
0 132 #63737b
0 133 #e7bd7b
0 134 #184a18
0 135 #f7bd5a
0 136 #000000
0 137 #f73829
0 138 #000000
0 139 #ffff52
0 140 #52794a
0 141 #639a5a
0 142 #c66142
0 143 #e76942
0 144 #ff7952
0 145 #dedede
0 146 #f3eed3
0 147 #f5ae5d
0 148 #95ce99
0 149 #b5157d
0 150 #eeeeee
0 151 #848484
0 152 #7b7b7b
0 153 #005a00
0 154 #e77373
0 155 #ffcb31
0 156 #29794a
0 157 #de2821
0 158 #2159c6
0 159 #f8f8f8
0 160 #e6e6e6
0 161 #21845a
0 162 #cdcdcd
0 163 #6c6c6c
0 164 #616161
0 165 #aeb2ae
0 166 #717171
0 167 #ff9a00
0 168 #c9c9c9
0 169 #dfd8df
0 170 #f7f3f7
6 0 3735 2205 6750
4 0 41 50 -1 14 16 5.7596 4 180 2310 80 3897 6692d179032205\001
4 0 41 50 -1 14 16 5.7596 4 180 2310 98 4230 b4116a96425a7f\001
4 0 41 50 -1 14 16 5.7596 4 180 2310 65 4545 ecc2ef51af1740\001
4 0 41 50 -1 14 16 5.7596 4 180 2310 61 4860 959d3b6d07bce4\001
4 0 41 50 -1 14 16 5.7596 4 180 2310 62 5220 fa9f2af29814d9\001
4 0 41 50 -1 14 16 5.7596 4 180 2310 5 5580 82592e77a204a8\001
-6
6 7515 3254 8762 6435
5 2 0 0 0 -1 50 -1 20 0.000 0 1 0 0 8396.605 4196.515 8760 4201 8680 3969 8472 3841
5 2 0 0 0 -1 50 -1 20 0.000 0 0 0 0 7877.176 4194.536 7516 4201 7595 3969 7803 3841
1 3 0 0 0 -1 50 -1 20 0.000 1 0.0000 8136 3514 260 260 8136 3514 8316 3702
2 4 0 0 0 -1 50 -1 20 0.000 0 0 8 0 0 5
7748 4104 7516 4104 7516 5110 7748 5110 7748 4104
2 4 0 0 0 -1 50 -1 20 0.000 0 0 8 0 0 5
8759 4104 8527 4104 8527 5110 8759 5110 8759 4104
2 4 0 0 0 -1 50 -1 20 0.000 0 0 10 0 0 5
8108 4895 7803 4895 7803 6435 8108 6435 8108 4895
2 4 0 0 0 -1 50 -1 20 0.000 0 0 10 0 0 5
8472 4895 8167 4895 8167 6435 8472 6435 8472 4895
2 2 0 0 0 -1 50 -1 20 0.000 0 0 -1 0 0 5
7803 5082 8472 5082 8472 3838 7803 3838 7803 5082
2 2 0 0 0 -1 50 -1 20 0.000 0 0 -1 0 0 5
7626 4250 8666 4250 8666 3969 7626 3969 7626 4250
-6
2 2 0 2 0 33 75 -1 20 0.000 0 0 -1 0 0 5
3465 2250 5940 2250 5940 2925 3465 2925 3465 2250
2 1 0 4 0 7 50 -1 -1 0.000 0 0 7 1 0 2
0 0 4.00 180.00 240.00
4680 2970 4680 3600
2 2 0 2 0 33 75 -1 20 0.000 0 0 -1 0 0 5
3465 3600 5940 3600 5940 4275 3465 4275 3465 3600
2 1 0 4 0 7 50 -1 -1 0.000 0 0 7 1 0 2
0 0 4.00 180.00 240.00
4680 4320 4680 4950
2 2 0 2 0 33 75 -1 20 0.000 0 0 -1 0 0 5
3465 4995 5940 4995 5940 5670 3465 5670 3465 4995
2 1 0 4 0 7 50 -1 -1 0.000 0 0 7 1 0 2
0 0 4.00 180.00 240.00
4680 5715 4680 6345
2 2 0 2 0 33 75 -1 20 0.000 0 0 -1 0 0 5
3465 6345 5940 6345 5940 7020 3465 7020 3465 6345
2 1 0 4 0 7 50 -1 -1 0.000 0 0 7 1 0 2
0 0 4.00 180.00 240.00
4680 7065 4680 7695
2 2 0 2 0 33 75 -1 20 0.000 0 0 -1 0 0 5
3465 7695 5940 7695 5940 8370 3465 8370 3465 7695
2 1 0 4 0 7 50 -1 -1 0.000 0 0 7 1 0 4
0 0 4.00 180.00 240.00
1980 5625 2610 5625 2610 2610 3420 2610
2 1 0 4 0 7 50 -1 -1 0.000 0 0 7 1 0 4
0 0 4.00 180.00 240.00
5985 8055 6615 8055 6615 5040 7425 5040
4 1 0 50 -1 2 16 0.0000 4 195 1245 4725 2655 Read Data\001
4 1 0 50 -1 2 16 0.0000 4 195 1320 4635 4050 Filter Data\001
4 1 0 50 -1 2 16 0.0000 4 255 1800 4725 5400 Resample Data\001
4 1 0 50 -1 2 16 0.0000 4 195 1755 4635 6750 Generate Data\001
4 1 0 50 -1 2 16 0.0000 4 255 1815 4725 8100 Spatialize Data\001
4 1 -1 50 -1 3 20 0.0000 4 225 1200 945 7020 raw data\001
4 1 -1 50 -1 3 20 0.0000 4 240 855 8145 6885 Caller\001
This diff is collapsed.
......@@ -88,6 +88,19 @@ namespace mio {
* @page general General concepts
* Since MeteoIO is a library, you, as an end user, will have a limited direct exposure to it: the library is called by the program that you are using, not directly by yourself. You will basically have to set some parameters in a configuration file that defines how MeteoIO has to behave. This configuration file is often named "io.ini" and follows the INI file format standard (see http://en.wikipedia.org/wiki/INI_file). In order to understand how this file is structured, let us first have a look at the general structure of MeteoIO and afterward the structure of this configuration file and where to find the available configuration parameters.
*
* @section typical_setup Typical setup
* \image html typical_setup.png "typical setup of MeteoIO for operational applications"
* \image latex typical_setup.eps "typical setup of MeteoIO for operational applications" width=0.9\textwidth
* MeteoIO has been designed to accomodate both the needs of carefully crafted simulations for a specific purpose/study and for the needs of operational
* simulations that run automatically and unattended. A typical setup for such operational applications consists of a data acquisition system
* (made of various sensors, usually mounted on a common mast, thus seen as belonging to a station and some system to bring the data back to some sort
* of data repository), a data storage system that usually has some way of also distributing the data (often a database but sometimes only data files on a disk)
* and is mostly seen as the data source by the application, some applications using the data and producing results that are published to
* their end users (either to an automated system that one can connect to or to some visualization tool that one can use to explore the results).
*
* In this setup, MeteoIO is the "glue" between the numerical model at the core of the application and the data sources on one hand and the
* publication system on the other hand.
*
* @section MeteoIO_structure General MeteoIO structure
* MeteoIO can be seen as a set of modules that is focused on the handling of input/output operations (including data preparation) for numerical simulations in the realm of earth sciences. On the visible side, it offers the following modules, working on a pre-determined set of \ref meteoparam "meteorological parameters" or on parameters added by the developer:
* - a set of \ref plugins "plugins" for accessing the data (for example, a plugin might be responsible for fetching the raw data from a given database)
......@@ -120,7 +133,7 @@ namespace mio {
* @endcode
*
* @subsection Config_structure Configuration file structure
* MeteoIO imposes a minimum structure to the configuration file: It must contain the [General], [Input] and [Output] sections. If any filter is to be used, a [Filters] section has to be present and if any spatial interpolation is to be used, an [Interpolations2D] section has to be present. A minimal set of keys has to be there, an potentially a number of optional keys. Moreover, the program that you are using might also impose you some specific keys or sections.
* MeteoIO imposes a minimum structure to the configuration %file: It must contain the [General], [Input] and [Output] sections. If any filter is to be used, a [Filters] section has to be present and if any spatial interpolation is to be used, an [Interpolations2D] section has to be present. A minimal set of keys has to be there, an potentially a number of optional keys. Moreover, the program that you are using might also impose you some specific keys or sections.
* The keys and their location in the configuration file (ie: to which section they belong) depends on the module that is actually using them. The optional keys depend on the specific options handled by each specific module (or plugin, or algorithm). Therefore, we can draw the following skeleton:
* @code
* [General]
......@@ -158,6 +171,7 @@ namespace mio {
*
* @subsection Finding_docs Where to find the proper documentation
* As can be seen from the previous example, each plugin, each filter or each interpolation algorithm might have its own parameters. Therefore, this is the documentation of each specific plugin/filter/algorithm that has to be used in order to figure out what can be configured when it (see the next sections in the welcome page).
*
*/
/**
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment