Home > atmlab > arts > qarts.m

qarts

PURPOSE ^

QARTS Defines setting fields for arts calculations

SYNOPSIS ^

function [Q,I] = qarts

DESCRIPTION ^

 QARTS   Defines setting fields for arts calculations

    The function defines all Qarts fields. All fields are initiated to {},
    that indicates that no value has been specified. No data will be
    transferred to arts for fields later not given a non-{} value. The
    settings are converted to control files by *qarts2cfile*. This function
    adds automatically method calls for saving (standard) variables.
    everything else must be specified by the qarts fields or be handled by
    include control files.

    This function is organised in such way that *qcheck* and *qinfo* can be
    used.

    Allowed formats differ between the fields. For information about a
    specific field, type e.g.:
       qinfo( @qarts, 'ABSORPTION' );

 FORMAT   [Q,I] = qarts
        
 OUT   Q  Setting structure (with all fields set to {}).
       I  Includes same fields as Q, where the content of each field
          is a description string (used by *qinfo*).

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

DOWNLOAD ^

qarts.m

SOURCE CODE ^

0001 % QARTS   Defines setting fields for arts calculations
0002 %
0003 %    The function defines all Qarts fields. All fields are initiated to {},
0004 %    that indicates that no value has been specified. No data will be
0005 %    transferred to arts for fields later not given a non-{} value. The
0006 %    settings are converted to control files by *qarts2cfile*. This function
0007 %    adds automatically method calls for saving (standard) variables.
0008 %    everything else must be specified by the qarts fields or be handled by
0009 %    include control files.
0010 %
0011 %    This function is organised in such way that *qcheck* and *qinfo* can be
0012 %    used.
0013 %
0014 %    Allowed formats differ between the fields. For information about a
0015 %    specific field, type e.g.:
0016 %       qinfo( @qarts, 'ABSORPTION' );
0017 %
0018 % FORMAT   [Q,I] = qarts
0019 %
0020 % OUT   Q  Setting structure (with all fields set to {}).
0021 %       I  Includes same fields as Q, where the content of each field
0022 %          is a description string (used by *qinfo*).
0023 
0024 % 2004-09-07   Created by Patrick Eriksson.
0025 
0026 
0027 function [Q,I] = qarts
0028  
0029 %-----------------------------------------------------------------------------
0030 Q.ABS_LINES = {};
0031 I.ABS_LINES = [ ...
0032 'The data on spectroscopic lines to use. See *ABS_LINES_FORMAT* for how ',...
0033 'to handle cases without lines. Can be given in two ways:', ...
0034 '#1. As a file name. All formats handled by arts can then be used. See', ...
0035 ' ABS_LINES_FORMAT. The reading is not restricted to any frequency range.', ...
0036 '#2. As an array of line data. This option is only allowed when ',...
0037 'ABS_LINES_FORMAT is set to ''Arts''.'
0038 ];
0039 %-----------------------------------------------------------------------------
0040 Q.ABS_LINES_FORMAT = {};
0041 I.ABS_LINES_FORMAT = [ ...
0042 'The format of spectroscopic data.', ...
0043 '#   Possible line formats are ''Arts'', ''Hitran'', ''Jpl'' and ',...
0044 '''Mytran2''. Note that these strings must be given exactly as stated here ',...
0045 '(first upper case etc.).',...
0046 '#   The field can further be set to ''None'' which indicates that no line ',...
0047 'data shall be included (the WSV *abs_lines_per_species* is set to be empty).'
0048 ];
0049 %-----------------------------------------------------------------------------
0050 Q.ABS_LINESHAPE = {};
0051 I.ABS_LINESHAPE = [ ...
0052 'The line shape to use. The same line shape is used for all tag groups.', ...
0053 ' Shall be a string. ', ...
0054 'Do "arts -d abs_lineshapeDefine" to list valid options.'
0055 ];
0056 %-----------------------------------------------------------------------------
0057 Q.ABS_LINESHAPE_CUTOFF = {};
0058 I.ABS_LINESHAPE_CUTOFF = [ ...
0059 'The line shape cut-off to apply. The same cut-off is used for all tag', ...
0060 ' groups. A value of -1 means no cut-off. ', ...
0061 'Do "arts -d abslineshapeDefine" for further information.'
0062 ];
0063 %-----------------------------------------------------------------------------
0064 Q.ABS_LINESHAPE_FACTOR = {};
0065 I.ABS_LINESHAPE_FACTOR = [ ...
0066 'The line shape normalisation factor to apply. The same factor is used', ...
0067 ' for all tag groups. Shall be a string. ', ...
0068 'Do "arts -d abs_lineshapeDefine" for valid options.'
0069 ];
0070 %-----------------------------------------------------------------------------
0071 Q.ABS_LOOKUP = {};
0072 I.ABS_LOOKUP = [ ...
0073 'Has the same functionality as the arts WSV with the same name.', ...
0074 '#   Can be given either as the name of a file, as a matching Matlab ',...
0075 'variable or control file text.'
0076 ];
0077 %-----------------------------------------------------------------------------
0078 Q.ABS_MODELS = {};
0079 I.ABS_MODELS = [ ...
0080 'Control files including descriptions of absorption models to ', ...
0081 'use (called continua in arts). This shall be a series of calls of ', ...
0082 '*abs_cont_descriptionAppend* (call of *abs_cont_descriptionInit* shall ',...
0083 'be included).',...
0084 '#   Given as an array of strings. The atmlab setting ARTS_INCLUDES is ',...
0085 'recognised. A file containing standard choices is: ',...
0086 'ARTS_INCLUDES/continua.arts'
0087 ];
0088 %-----------------------------------------------------------------------------
0089 Q.ABS_NLS = {};
0090 I.ABS_NLS = [ ...
0091 'As the arts WSV with the same name. Only needed if an absorption look-up ', ...
0092 'shall be calculated. Can be set by *qarts_abs_species*.',...
0093 '#   Can be given either as the name of a file, as a matching Matlab ',...
0094 'variable or control file text.'
0095 ];
0096 %-----------------------------------------------------------------------------
0097 Q.ABS_NLS_PERT = {};
0098 I.ABS_NLS_PERT = [ ...
0099 'As the arts WSV with the same name. Only needed if an absorption look-up ', ...
0100 'shall be calculated. See *qarts_set_abs_lookup* for simple setting of ',...
0101 'this field.',...
0102 '#   Can be given either as the name of a file, as a matching Matlab ',...
0103 'variable or control file text. Empty ([]) signifies no perturbations.'
0104 ];
0105 %-----------------------------------------------------------------------------
0106 Q.ABS_P = {};
0107 I.ABS_P = [ ...
0108 'As the arts WSV with the same name. Only needed if an absorption look-up ', ...
0109 'shall be calculated. See *qarts_set_abs_lookup* for simple setting of ',...
0110 'this field.',...
0111 '#   Can be given either as the name of a file, as a matching Matlab ',...
0112 'variable or control file text.'
0113 ];
0114 %-----------------------------------------------------------------------------
0115 Q.ABS_SPECIES = {};
0116 I.ABS_SPECIES = [ ...
0117 'Specification of absorption species. Arts requires in many cases that ', ...
0118 'H2O and N2 are included. ',... 
0119 'This is a structure array defining species and associated retrieval ',...
0120 'variables. These sub-fields are defined: ', ...
0121 '# ',...
0122 '#<TAG> Tag group data, following *arts_tgs_cnvrt*.', ...
0123 '# ',...
0124 '#<ATMDATA> VMR data for the species. The input shall follow the atmdata ',...
0125 'format, defined in *isatmdata*. The data specified here are not directly ',...
0126 'given to arts, it can only be used to set-up *VMR_FIELD*. This step is ',...
0127 'handled by *qarts_vmr_field*. The field is accordingly not mandatory. ',...
0128 'The main usage of this field should be to import data of climatology ',...
0129 'character. Can be given as a variable or a file saved through *gf_save*. ',...
0130 'This field is recognised and used automatically by Qpack2.',...
0131 '# ',...
0132 '#<RETRIEVE> If set to true the species is retrieved. Otherwise the ', ...
0133 'species is not retrieved (what a surprise!).', ...
0134 '# ',...
0135 '#<UNIT> Retrieval unit. Allowed choices are ''rel'', ''vmr'', ''nd'', ', ...
0136 'and ''logrel''. For some more information:',...
0137 '#arts -d jacobianAddAbsSpecies.', ...
0138 '# ',...
0139 '#<GRIDS> Retrieval grids for the species. An array of vectors of length 3:',...
0140 ' {p_grid,lat_grid,lon_grid}. Grids for dimensions not used shall be ',...
0141 'empty.',...
0142 '# ',...
0143 '#<SX> Covariance matrix of a priori knowledge for the species. Size must ',...
0144 'match the grid field. Data must match <UNIT>. A matrix, that can be ',...
0145 'sparse.',...
0146 '# ',...
0147 '#<L2> Flag for any function creating L2 data. See comments for ',...
0148 '*L2_EXTRA*. If set to true, the retrieved state for the species ',...
0149 'will be included in the L2 output. Otherwise not. This field has no ',...
0150 'importance if RETRIEVE is false.',...
0151 '# ',...
0152 '#<L2_RANGE> Fine tuning of L2 data ranges. ',...
0153 'The default is to store data directly matching the retrieval ',...
0154 'grids. This is done if the field is non-existing. This ',...
0155 'field allows you to either crop or extend range of the L2 data. ',...
0156 'It is then a vector of length, at least, twice the atmospheric ',...
0157 'dimensionality: [p_min p_max lat_min lat_max lon_min lon_max] where ',...
0158 'lat_min gives the minimum latitude to include etc. ',...
0159 '# If a given limit is inside the range covered by the corresponding ',...
0160 'retrieval grid, this results in that the data are cropped. This ',...
0161 'feature can be used to remove parts that are of no interest for ',...
0162 'L2 data (such as parts always having a low measurement response). ',...
0163 '# The default L2 output is not reflecting the fact that values at ',...
0164 'end points of the retrieval grids are valid all the way to the ',...
0165 'matching atmospheric limit. This field can also be used to ',...
0166 'incorporate this part. If a limit is outside the retrieval grid, ',...
0167 'the L2 data will also include the retrieved state at the ',...
0168 'specified or the atmospheric limit (which is the closest to the ',...
0169 'retrieval grid). In practice this signifies a duplication of end point ',...
0170 'data.',...
0171 '# Only retrieved profile and errors are modified. Averaging kernel, ',...
0172 'covariance and gain matrices are kept consistent with the original ',...
0173 'retrieval grids.'...
0174 '# ',...
0175 '#<MINMAX> Min and max allowed value for retrievals. A single min and ',...
0176 'max value is applied for each species. The field can be left undefined, ',...
0177 'be empty, be a scalar or vector of length 2. A single value as taken as ',...
0178 'min, and is then set to Inf. The min value can be set to -Inf. The unit',...
0179 'follows the field *UNIT*.',...
0180 '# The primary usage of the field should be to avoid negative vmr values. ',...
0181 '(The limits are applied also during the iterations of a non-linear inversion.'
0182 ];
0183 %-----------------------------------------------------------------------------
0184 Q.ABS_T = {};
0185 I.ABS_T = [ ...
0186 'As the arts WSV with the same name. Only needed if an absorption look-up ', ...
0187 'shall be calculated. See *qarts_set_abs_lookup* for simple setting of ',...
0188 'this field.',...
0189 '#   Can be given either as the name of a file, as a matching Matlab ',...
0190 'variable or control file text.'
0191 ];
0192 %-----------------------------------------------------------------------------
0193 Q.ABS_T_PERT = {};
0194 I.ABS_T_PERT = [ ...
0195 'As the arts WSV with the same name. Only needed if an absorption look-up ', ...
0196 'shall be calculated. See *qarts_set_abs_lookup* for simple setting of ',...
0197 'this field.',...
0198 '#   Can be given either as the name of a file, as a matching Matlab ',...
0199 'variable or control file text.'
0200 ];
0201 %-----------------------------------------------------------------------------
0202 Q.ABS_VMRS = {};
0203 I.ABS_VMRS = [ ...
0204 'As the arts WSV with the same name. Only needed if an absorption look-up ', ...
0205 'shall be calculated. See *qarts_set_abs_lookup* for simple setting of ',...
0206 'this field.',...
0207 '#   Can be given either as the name of a file, as a matching Matlab ',...
0208 'variable or control file text.'
0209 ];
0210 %-----------------------------------------------------------------------------
0211 Q.ABS_WSMS = {};
0212 I.ABS_WSMS = [ ...
0213 'Workspace method calls to include just before calculation of absorption. ',...
0214 'Format and options as WSMS_AT_START.'
0215 ];
0216 %-----------------------------------------------------------------------------
0217 Q.ABS_XSEC_AGENDA = {};
0218 I.ABS_XSEC_AGENDA = [ ...
0219 'As the arts WSV with the same name. WSMs are listed as an array of ',...
0220 'strings.',...
0221 '#   If the field *ABSORPTION* is set, this agenda is set to its most ',...
0222 'common choice. Accordingly, this field is only needed if your ',...
0223 'calculations require a deviating agenda definition.'
0224 ];
0225 %-----------------------------------------------------------------------------
0226 Q.ABSORPTION = {};
0227 I.ABSORPTION = [ ...
0228 'String describing how absorption shall be calculated/obtained. ',...
0229 'Existing options are:', ...
0230 '#    {}        : Absorption variables defined by include files. All ',...
0231 'absorption fields above will be ignored.',...    
0232 '#   ''OnTheFly'' : Absorption is calculated for each propagation path ',...
0233 'point. The agenda *abs_scalar_gas_agenda* must here be set by an include ',...
0234 'file. No other absorption variables need to be set.',...
0235 '#   ''CalcTable'': Calculate and use an absorption look-up table. See ',...
0236 '*qarts_abstable* for simple setting of needed variables.',...
0237 '#   ''LoadTable'': Load and use pre-calculated absorption look-up table, ',...
0238 'defined by field *ABS_LOOKUP*.',...
0239 '#If this field is set, *ABS_XSEC_AGENDA* and *PROPMAT_CLEARSKY_AGENDA* ',...
0240 'are set matching calculations of standard type.'
0241 ];
0242 %-----------------------------------------------------------------------------
0243 Q.ANTENNA_DIM = {};
0244 I.ANTENNA_DIM = [ ...
0245 'As the arts WSV with the same name.', ...
0246 '#   This field can be ignored, depending on SENSOR_RESPONSE.'
0247 ];
0248 %-----------------------------------------------------------------------------
0249 Q.ATMOSPHERE_DIM = {};
0250 I.ATMOSPHERE_DIM = [ ...
0251 'As the arts WSV with the same name.'
0252 ];
0253 %-----------------------------------------------------------------------------
0254 Q.BATCH = {};
0255 I.BATCH = [ ...
0256 'Batch calculations. Defined by a structure, described in ',...
0257 '*qartsBatch*. Type ''qinfo(@qartsBatch);'' for further information. ',...
0258 'Batch calculations are not started automatically (in e.g. *arts_y*), but ',...
0259 'must be selected specifically (most easily done by using *arts_batch*).' 
0260 ];
0261 %-----------------------------------------------------------------------------
0262 Q.BLACKBODY_RADIATION_AGENDA = {};
0263 I.BLACKBODY_RADIATION_AGENDA = [ ...
0264 'As the arts WSV with the same name. WSMs are listed as an array of strings.'
0265 ];
0266 %-----------------------------------------------------------------------------
0267 Q.CLOUDBOX = {};
0268 I.CLOUDBOX = [ ...
0269 'Handling of cloudbox/scattering. Defined by a structure, described in ',...
0270 '*qartsCloudbox*. Type ''qinfo(@qartsCloudbox);'' for further information.'
0271 ];
0272 %-----------------------------------------------------------------------------
0273 Q.CLOUDBOX_DO = {};
0274 I.CLOUDBOX_DO = [ ...
0275 'Boolean to activate the cloud box (scattering calculations), or not.',...
0276 '#   {}: Nothing is done. Relevant data are assumed to be specified by ',...
0277 'inclusion files.',...
0278 '#    0: Call of *cloudboxOff* is included.',...
0279 '#    1: Action follows setting of field *CLOUDBOX*.'
0280 ];
0281 %-----------------------------------------------------------------------------
0282 Q.F_GRID = {};
0283 I.F_GRID = [ ...
0284 'Has the same functionality as the arts WSV with the same name.', ...
0285 '#   Can be given either as the name of a file, as a matching Matlab ',...
0286 'variable or control file text.'
0287 ];
0288 %-----------------------------------------------------------------------------
0289 Q.FSHIFTFIT = {};
0290 I.FSHIFTFIT = [ ...
0291 'Structure for specification of frequency shift retrievals. No retrieval',...
0292 'is made if field is empty or sub-field RETRIEVAL is set to false. The WSM ',...
0293 'used is *jacobianAddFreqShift*. The polynomial order is hard-coded to ',...
0294 'zero. These sub-fields are defined:',...
0295 '# ',...
0296 '#<RETRIEVE> Flag to activate frequency retrieval.', ...    
0297 '# ',...
0298 '#<DF> Size for numerical perturbation.', ...
0299 '# ',...
0300 '#<SX> Variance of a priori knowledge on the variable.',...
0301 '# ',...
0302 '#<L2> Flag for any function creating L2 data. See comments for ',...
0303 '*L2_EXTRA*. If set to true, the retrieved frequency fit variables ',...
0304 'will be included in the L2 output. Otherwise not. This field has no ',...
0305 'importance if RETRIEVE is false.'
0306 ];
0307 %-----------------------------------------------------------------------------
0308 Q.FSTRETCHFIT = {};
0309 I.FSTRETCHFIT = [ ...
0310 'Structure for specification of frequency stretch retrievals. No retrieval ',...
0311 'is made if field is empty or sub-field RETRIEVAL is set to false. The WSM ',...
0312 'used is *jacobianAddFreqStretch*. The polynomial order is hard-coded to ',...
0313 'zero. These sub-fields are defined:',...
0314 '# ',...
0315 '#<RETRIEVE> Flag to activate frequency retrieval.', ...    
0316 '# ',...
0317 '#<DF> Size for numerical perturbation.', ...
0318 '# ',...
0319 '#<SX> Variance of a priori knowledge on the variable.',...
0320 '# ',...
0321 '#<L2> Flag for any function creating L2 data. See comments for ',...
0322 '*L2_EXTRA*. If set to true, the retrieved frequency fit variables ',...
0323 'will be included in the L2 output. Otherwise not. This field has no ',...
0324 'importance if RETRIEVE is false.'
0325 ];
0326 %-----------------------------------------------------------------------------
0327 Q.HSE = {};
0328 I.HSE = [ ...
0329 'Variables associated with hydrostatic equilibrium. A structure with the ',...
0330 'sub-fields:',...
0331 '# ',...
0332 '#<ON> Flag to enforce hydrostatic equilibrium. If true, the WSV *z_field*',... 
0333 'is recalculated by *z_fieldFromHSE* (note that a "first guess" *z_field* ',... 
0334 'must be provided).',...
0335 '# ',...
0336 '#<P> Pressure for reference point. Matches the WSV *p_hse*.',...
0337 '# ',...
0338 '#<ACCURACY> Calculation accuracy. Matches the WSV *z_hse_accuracy*.',...
0339 '# ',...
0340 '#If the field is unset, no action is taken. This equals to set Q.HSE.ON ',...
0341 'to false. Note the setting Q.T.HSE which controls the calculation of t-',...
0342 'jacobians. The two settings are treated as independent, but should ',...
0343 'be set to the same value (true/false). If the HSE is maintained during ',...
0344 'the iterations of a temperature retrieval is controlled by THIS field.'
0345 ];    
0346 %-----------------------------------------------------------------------------
0347 Q.INCLUDES = {};
0348 I.INCLUDES = [ ...
0349 'Paths to control files to be included. These files will be included ',...
0350 'at the top of the control file, only preceded by WSMS_AT_START. Given ',...
0351 'as an array of strings. Format and options as for WSMS_AT_START.',...
0352 '#   The atmlab setting ARTS_INCLUDES is recognised. To include the ',...
0353 'standard arts general definition file, select:',...
0354 '{''ARTS_INCLUDES/general.arts''}'
0355 ];
0356 %-----------------------------------------------------------------------------
0357 Q.INPUT_FILE_FORMAT = 'binary';
0358 I.INPUT_FILE_FORMAT = [ ...
0359 'The file format for arts input files. That is, the format of the files ',...
0360 'created in Matlab to be read by arts. Possible options are ''binary'', '...
0361 'and ''double''. The binary option, that is default, should be most '...
0362 'efficient. Use ''double'' if you want to visually inspect the files ',...
0363 'generated. (The option ''float'' is not allowed, as this is not always '...
0364 'sufficient for frequency data.)'
0365 ];
0366 %-----------------------------------------------------------------------------
0367 Q.IY_AUX_VARS = {};
0368 I.IY_AUX_VARS = [ ...
0369 'As the arts WSV with the same name.'
0370 ];
0371 %-----------------------------------------------------------------------------
0372 Q.IY_MAIN_AGENDA = {};
0373 I.IY_MAIN_AGENDA = [ ...
0374 'As the arts WSV with the same name. WSMs are listed as an array of strings.'
0375 ];
0376 %-----------------------------------------------------------------------------
0377 Q.IY_SPACE_AGENDA = {};
0378 I.IY_SPACE_AGENDA = [ ...
0379 'As the arts WSV with the same name. WSMs are listed as an array of strings.'
0380 
0381 ];
0382 %-----------------------------------------------------------------------------
0383 Q.IY_SUB_AGENDA = {};
0384 I.IY_SUB_AGENDA = [ ...
0385 'As the arts WSV with the same name. WSMs are listed as an array of strings.'
0386 ];
0387 %-----------------------------------------------------------------------------
0388 Q.IY_SURFACE_AGENDA = {};
0389 I.IY_SURFACE_AGENDA = [ ...
0390 'As the arts WSV with the same name. WSMs are listed as an array of strings.'
0391 ];
0392 %-----------------------------------------------------------------------------
0393 Q.IY_TRANSMITTER_AGENDA = {};
0394 I.IY_TRANSMITTER_AGENDA = [ ...
0395 'As the arts WSV with the same name. WSMs are listed as an array of strings.'
0396 ];
0397 %-----------------------------------------------------------------------------
0398 Q.IY_UNIT = {};
0399 I.IY_UNIT = [ ...
0400 'As the arts WSV with the same name. That is, the radiance unit. ',...
0401 'The options include:', ...
0402 '#   ''1''       : Basic radiances [W/m2/Hz/sr]',...
0403 '#   ''RJBT''    : Conversion to brightness temperature by the Rayleigh-',...
0404 'Jeans approximation of the Planck function.',...
0405 '#   ''PlanckBT'': Conversion to brightness temperature by the Planck ',...
0406     'function.',...
0407 '#For further information: ''arts -d iy_unit''.'
0408 ];
0409 %-----------------------------------------------------------------------------
0410 Q.J_DO = {};
0411 I.J_DO = [ ...
0412 'Boolean to include calculation of jacobians.',...
0413 '#   {}: Nothing is done. Relevant data are assumed to be specified by ',...
0414 'inclusion files.',...
0415 '#    0: Call of *jacobianOff* is included.',...
0416 '#    1: Action follows setting of field *J*.'
0417 ];
0418 %-----------------------------------------------------------------------------
0419 Q.LAT_GRID = {};
0420 I.LAT_GRID = [ ...
0421 'As the arts WSV with the same name. For example, shall be empty for 1D ', ...
0422 'simulations.',...
0423 '#   Can be given either as the name of a file, as a matching Matlab ',...
0424 'variable or control file text.'
0425 ];
0426 %-----------------------------------------------------------------------------
0427 Q.LAT_TRUE = {};
0428 I.LAT_TRUE = [ ...
0429 'As the arts WSV with the same name.',...
0430 '#   Can be given either as the name of a file, as a matching Matlab ',...
0431 'variable or control file text.'
0432 ];
0433 %-----------------------------------------------------------------------------
0434 Q.LON_GRID = {};
0435 I.LON_GRID = [ ...
0436 'As the arts WSV with the same name. For example, shall be empty for 1D ', ...
0437 'and 2D simulations.',...
0438 '#   Can be given either as the name of a file, as a matching Matlab ',...
0439 'variable or control file text.'
0440 ];
0441 %-----------------------------------------------------------------------------
0442 Q.LON_TRUE = {};
0443 I.LON_TRUE = [ ...
0444 'As the arts WSV with the same name.',...
0445 '#   Can be given either as the name of a file, as a matching Matlab ',...
0446 'variable or control file text.'
0447 ];
0448 %-----------------------------------------------------------------------------
0449 Q.L2_EXTRA = {};
0450 I.L2_EXTRA = [ ...
0451 'Information to functions repacking retrieval information. Such a product ', ...
0452 'is normally denoted as L2 data. This field lists data to be included ', ...
0453 'beside the direct retrieval quantities, for which their L2 field has ',...
0454 'the same functionality. The information is given as string array, e.g.:',...
0455 '#    Q.L2_EXTRA = {''cost'',''mresp'',''ptz''}',...
0456 '#There is no general L2 function and the possible data output (and ',...
0457 'coding) differs between the functions.'
0458 ];
0459 %-----------------------------------------------------------------------------
0460 Q.MAG_U_FIELD = {};
0461 I.MAG_U_FIELD = [ ...
0462 'As the arts WSV with the same name. Can be set to [].', ...
0463 '#   Can be given either as the name of a file, as a matching Matlab ',...
0464 'variable or control file text.'
0465 ];
0466 %-----------------------------------------------------------------------------
0467 Q.MAG_U = {};
0468 I.MAG_U = [ ...
0469 'Data and settings associated with MAG_U_FIELD. Has the same role as T with ',...
0470 'respect to T_FIELD, but as there are no retrievals associated with MAG_U ',...
0471 'there is only one sub-field here:',...
0472 '# ',...
0473 '#<ATMDATA> The input shall follow the atmdata format, defined in ',...
0474 '*isatmdata*. The data specified here are not directly given to arts, it ',...
0475 'can only be used to set-up *MAG_U_FIELD*. This step is handled by ',...
0476 '*qarts_atm_field*. The main usage of this field should be to import ',...
0477 'data of climatology character. Can be given as a variable or a file saved ',...
0478 'through *gf_save*. ',...
0479 'This field is recognised and used automatically by Qpack2.',...
0480 ];
0481 %-----------------------------------------------------------------------------
0482 Q.MAG_V_FIELD = {};
0483 I.MAG_V_FIELD = [ ...
0484 'As the arts WSV with the same name. Can be set to [].', ...
0485 '#   Can be given either as the name of a file, as a matching Matlab ',...
0486 'variable or control file text.'
0487 ];
0488 %-----------------------------------------------------------------------------
0489 Q.MAG_V = {};
0490 I.MAG_V = [ ...
0491 'Data and settings associated with the v-component of the magnetic field. ',...
0492 'Defined as MAG_U, and the details are nor repeated here.'
0493 ];
0494 %-----------------------------------------------------------------------------
0495 Q.MAG_W_FIELD = {};
0496 I.MAG_W_FIELD = [ ...
0497 'As the arts WSV with the same name. Can be set to [].', ...
0498 '#   Can be given either as the name of a file, as a matching Matlab ',...
0499 'variable or control file text.'
0500 ];
0501 %-----------------------------------------------------------------------------
0502 Q.MAG_W = {};
0503 I.MAG_W = [ ...
0504 'Data and settings associated with the w-component of the magnetic field. ',...
0505 'Defined as MAG_U, and the details are nor repeated here.'
0506 ];
0507 %-----------------------------------------------------------------------------
0508 Q.MBLOCK_AA_GRID = {};
0509 I.MBLOCK_AA_GRID = [ ...
0510 'Has the same functionality as the arts WSV with the same name. ', ...
0511 'This field can be ignored, depending on setting of SENSOR_RESPONSE.',...
0512 '#   If the antenna dimension is 1, this variable can be left as {}. ', ...
0513 'For 2D antennas it has to be set even if the sensor does not include an ', ...
0514 'antenna.', ...
0515 '#   Can be given either as the name of a file, as a matching Matlab ',...
0516 'variable or control file text.'
0517 ];
0518 %-----------------------------------------------------------------------------
0519 Q.MBLOCK_ZA_GRID = {};
0520 I.MBLOCK_ZA_GRID = [ ...
0521 'Has the same functionality as the arts WSV with the same name. ', ...
0522 'This has to be set even if the sensor does not include an antenna.', ...
0523 '#   Can be given either as the name of a file, as a matching Matlab ',...
0524 'variable or control file text.'
0525 ];
0526 %-----------------------------------------------------------------------------
0527 Q.OUTPUT_FILE_FORMAT = {};
0528 I.OUTPUT_FILE_FORMAT = [ ...
0529 'As the arts WSV with the same name. That is, the format for files created ',...
0530 'by arts. Possible options are ''binary'' and ''ascii''. The binary option ',...
0531 'should in general be most efficient.'
0532 ];
0533 %-----------------------------------------------------------------------------
0534 Q.P_GRID = {};
0535 I.P_GRID = [ ...
0536 'Has the same functionality as the arts WSV with the same name.', ...
0537 '#   Can be given either as the name of a file, as a matching Matlab ',...
0538 'variable or control file text.'
0539 ];
0540 %-----------------------------------------------------------------------------
0541 Q.POINTING = {};
0542 I.POINTING = [ ...
0543 'Structure for specification of pointing fit retrievals. No retrieval is', ...
0544 'made if field is empty or sub-field RETRIEVAL is set to false. The WSM ',...
0545 'used is *jacobianAddPointingZa*. These sub-fields are defined:',...
0546 '# ',...
0547 '#<RETRIEVE> Flag to activate pointing retrieval.', ...    
0548 '# ',...
0549 '#<DZA> Size for numerical perturbation. See used WSM.', ...
0550 '# ',...
0551 '#<POLY_ORDER> Order of polynomial to describe the time variation of ',...
0552 'pointing errors.', ...
0553 '# ',...
0554 '#<CALCMODE> The manner in which the jacobian is determined. See  used WSM',...
0555 '# ',...
0556 '#<SX> Covariance matrix of a priori knowledge for pointing fit variables. ',...
0557 'A square matrix of size POLY_ORDER+1.',...
0558 '# ',...
0559 '#<L2> Flag for any function creating L2 data. See comments for ',...
0560 '*L2_EXTRA*. If set to true, the retrieved pointing variables ',...
0561 'will be included in the L2 output. Otherwise not. This field has no ',...
0562 'importance if RETRIEVE is false.'
0563 ];
0564 %-----------------------------------------------------------------------------
0565 Q.POLYFIT = {};
0566 I.POLYFIT = [ ...
0567 'Structure for specification of polynomial baseline fits. No retrieval is', ...
0568 'made if field is empty or sub-field RETRIEVAL is set to false. The WSM ',...
0569 'used is *jacobianAddPolyfit*. All no_xxx_variation arguments of the WSM ',...
0570 'are set to default value. The different polynomial coefficients are ',...
0571 'assumed to be uncorrelated. These sub-fields are defined:',...
0572 '# ',...
0573 '#<RETRIEVE> Flag to activate pointing retrieval', ...    
0574 '# ',...
0575 '#<ORDER> Order of polynomial fit.', ...
0576 '# ',...
0577 '#<SX0> Covariance matrix of a priori knowledge for coefficient of order ',...
0578 'zero. There shall be such a matrix for each coefficient order until:',...
0579 '# ',...
0580 '#<SXn> Covariance matrix of a priori knowledge for coefficient of order ',...
0581 'POLY_ORDER. The last required covariance matrix.',...
0582 '# ',...
0583 '#<L2> Flag for any function creating L2 data. See comments for ',...
0584 '*L2_EXTRA*. If set to true, the retrieved baseline variables ',...
0585 'will be included in the L2 output. Otherwise not. This field has no ',...
0586 'importance if RETRIEVE is false.'
0587 ];
0588 %-----------------------------------------------------------------------------
0589 Q.PPATH_AGENDA = {};
0590 I.PPATH_AGENDA = [ ...
0591 'As the arts WSV with the same name. WSMs are listed as an array of strings.'
0592 ];
0593 %-----------------------------------------------------------------------------
0594 Q.PPATH_LMAX = {};
0595 I.PPATH_LMAX = [ ...
0596 'As the arts WSV with the same name .', ...
0597 '#   Can be given either as the name of a file, as a matching Matlab ',...
0598 'variable or control file text.'
0599 ];
0600 %-----------------------------------------------------------------------------
0601 Q.PPATH_LRAYTRACE = {};
0602 I.PPATH_LRAYTRACE = [ ...
0603 'As the arts WSV with the same name .', ...
0604 '#   Can be given either as the name of a file, as a matching Matlab ',...
0605 'variable or control file text.'
0606 ];
0607 %-----------------------------------------------------------------------------
0608 Q.PPATH_STEP_AGENDA = {};
0609 I.PPATH_STEP_AGENDA = [ ...
0610 'As the arts WSV with the same name. WSMs are listed as an array of strings.'
0611 ];
0612 %-----------------------------------------------------------------------------
0613 Q.PROPMAT_CLEARSKY_AGENDA = {};
0614 I.PROPMAT_CLEARSKY_AGENDA = [ ...
0615 'As the arts WSV with the same name. WSMs are listed as an array of ',...
0616 'strings.',...
0617 '#   If the field *ABSORPTION* is set, this agenda is set to its most ',...
0618 'common choice (for the selected ABSORPTION option). Accordingly, this ',...
0619 'field is only needed if your calculations require a deviating agenda ',...
0620 'definition.'
0621 ];
0622 %-----------------------------------------------------------------------------
0623 Q.RAW_ATMOSPHERE = {};
0624 I.RAW_ATMOSPHERE = [ ...
0625 'If set, a "raw atmosphere" in read. This is the main file name for the ',...
0626 'raw atmosphere. See further ''arts -d AtmRawRead''.',...
0627 '#Data in the fields T_FIELD, Z_FIELD or VMR_FIELD are included at a later ',...
0628 'stage and will then overwrite the data from the raw atmosphere. This ',...
0629 'gives thus some flexibility to mix data from different sources.'
0630 ];
0631 %-----------------------------------------------------------------------------
0632 Q.RAW_ATM_EXPAND_1D = {};
0633 I.RAW_ATM_EXPAND_1D = [ ...
0634 'Boolean to expand an 1D raw atmosphere to set ATMOSPHERE_DIM. If set to ',...
0635 '1, the WSM *AtmFieldsCalcExpand1D* is used instead of *AtmFieldsCalc*.',...
0636 'This variable is only used if RAW_ATMOSPHERE is set.'
0637 ];
0638 %-----------------------------------------------------------------------------
0639 Q.REFELLIPSOID = {};
0640 I.REFELLIPSOID = [ ...
0641 'Reference ellipsoid. As the arts WSV with the same name .'
0642 ];
0643 %-----------------------------------------------------------------------------
0644 Q.REFR_INDEX_AIR_AGENDA = {};
0645 I.REFR_INDEX_AIR_AGENDA = [ ...
0646 'As the arts WSV with the same name. WSMs are listed as an array of strings.'
0647 ];
0648 %-----------------------------------------------------------------------------
0649 Q.SENSOR_DO = {};
0650 I.SENSOR_DO = [ ...
0651 'Boolean to include sensor characteristics. Otherwise monochromatic pencil ',...
0652 'beam calculations are performed. *SENSOR_POS/LOS* are used in both cases. ',...
0653 '#   {}: Nothing is done. Relevant data are assumed to be specified by ',...
0654 'inclusion files.',...
0655 '#    0: Call of *sensorOff* is included.',...
0656 '#    1: Action follows setting of field *SENSOR_RESPONSE*.'
0657 ];
0658 %-----------------------------------------------------------------------------
0659 Q.SENSOR_LOS = {};
0660 I.SENSOR_LOS = [ ...
0661 'As the arts WSV with the same name.'
0662 ];
0663 %-----------------------------------------------------------------------------
0664 Q.SENSOR_POS = {};
0665 I.SENSOR_POS = [ ...
0666 'As the arts WSV with the same name.'
0667 ];
0668 %-----------------------------------------------------------------------------
0669 Q.SENSOR_RESPONSE = {};
0670 I.SENSOR_RESPONSE = [ ...
0671 'As the arts WSV with the same name. Three main options exist:', ...
0672 '#1: The first option is to specify each variable associated with the ',...
0673 'sensor individually. This field can then be the name of a XML file or ',...
0674 'a Matlab sparse matrix. Other fields that must be specified for this ',...
0675 'option include: ANTENNA_DIM, MBLOCK_ZA/AA_GRID and ',...
0676 'SENSOR_RESPONSE_F/ZA/AA/POL.',...
0677 '#2: The name of control files to include (ARTS_INCLUDES recognised). ',...
0678 'Given as an array of strings.',...
0679 '#3: Calculate the response from basic data. This field shall then be a ',...
0680 'structure, following the definitions in *qartsSensor*. Type ',...
0681 '''qinfo(@qartsSensor);'' for definition of required data fields.',...
0682 'Other fields that must/may be specified here include ANTENNA_DIM and ',...
0683 'MBLOCK_ZA/AA_GRID.'
0684 ];
0685 %-----------------------------------------------------------------------------
0686 Q.SENSOR_RESPONSE_AA = {};
0687 I.SENSOR_RESPONSE_AA = [ ...
0688 'As the arts WSV with the same name. ', ...
0689 'This field can be ignored, depending on setting of SENSOR_RESPONSE.',...
0690 '#   Can be given either as the name of a file, as a matching Matlab ',...
0691 'variable or control file text.'
0692 ];
0693 %-----------------------------------------------------------------------------
0694 Q.SENSOR_RESPONSE_AA_GRID = {};
0695 I.SENSOR_RESPONSE_AA_GRID = [ ...
0696 'As the arts WSV with the same name. ', ...
0697 'This field can be ignored, depending on setting of SENSOR_RESPONSE.',...
0698 '#   Can be given either as the name of a file, as a matching Matlab ',...
0699 'variable or control file text.'
0700 ];
0701 %-----------------------------------------------------------------------------
0702 Q.SENSOR_RESPONSE_F = {};
0703 I.SENSOR_RESPONSE_F = [ ...
0704 'As the arts WSV with the same name. ', ...
0705 'This field can be ignored, depending on setting of SENSOR_RESPONSE.',...
0706 '#   Can be given either as the name of a file, as a matching Matlab ',...
0707 'variable or control file text.'
0708 ];
0709 %-----------------------------------------------------------------------------
0710 Q.SENSOR_RESPONSE_F_GRID = {};
0711 I.SENSOR_RESPONSE_F_GRID = [ ...
0712 'As the arts WSV with the same name. ', ...
0713 'This field can be ignored, depending on setting of SENSOR_RESPONSE.',...
0714 '#   Can be given either as the name of a file, as a matching Matlab ',...
0715 'variable or control file text.'
0716 ];
0717 %-----------------------------------------------------------------------------
0718 Q.SENSOR_RESPONSE_POL = {};
0719 I.SENSOR_RESPONSE_POL = [ ...
0720 'As the arts WSV with the same name. ', ...
0721 'This field can be ignored, depending on setting of SENSOR_RESPONSE.',...
0722 '#   Can be given either as the name of a file, as a matching Matlab ',...
0723 'variable or control file text.'
0724 ];
0725 %-----------------------------------------------------------------------------
0726 Q.SENSOR_RESPONSE_POL_GRID = {};
0727 I.SENSOR_RESPONSE_POL_GRID = [ ...
0728 'As the arts WSV with the same name. ', ...
0729 'This field can be ignored, depending on setting of SENSOR_RESPONSE.',...
0730 '#   Can be given either as the name of a file, as a matching Matlab ',...
0731 'variable or control file text.'
0732 ];
0733 %-----------------------------------------------------------------------------
0734 Q.SENSOR_RESPONSE_ZA = {};
0735 I.SENSOR_RESPONSE_ZA = [ ...
0736 'As the arts WSV with the same name. ', ...
0737 'This field can be ignored, depending on setting of SENSOR_RESPONSE.',...
0738 '#   Can be given either as the name of a file, as a matching Matlab ',...
0739 'variable or control file text.'
0740 ];
0741 %-----------------------------------------------------------------------------
0742 Q.SENSOR_RESPONSE_ZA_GRID = {};
0743 I.SENSOR_RESPONSE_ZA_GRID = [ ...
0744 'As the arts WSV with the same name. ', ...
0745 'This field can be ignored, depending on setting of SENSOR_RESPONSE.',...
0746 '#   Can be given either as the name of a file, as a matching Matlab ',...
0747 'variable or control file text.'
0748 ];
0749 %-----------------------------------------------------------------------------
0750 Q.SENSOR_TIME = {};
0751 I.SENSOR_TIME = [ ...
0752 'As the arts WSV with the same name.'
0753 ];
0754 %-----------------------------------------------------------------------------
0755 Q.SINEFIT = {};
0756 I.SINEFIT = [ ...
0757 'Structure for specification of sinusoidal baseline fits. No retrieval is', ...
0758 'made if field is empty or sub-field RETRIEVAL is set to false. The WSM ',...
0759 'used is *jacobianAddSinefit*. All no_xxx_variation arguments of the WSM ',...
0760 'are set to default value. The different period lengths are assumed ',...
0761 'to be uncorrelated. These sub-fields are defined:',...
0762 '# ',...
0763 '#<RETRIEVE> Flag to activate retrieval', ...    
0764 '# ',...
0765 '#<PERIODS> Period lengths of the fit.', ...
0766 '# ',...
0767 '#<SX1> Covariance matrix of a priori knowledge for coefficients of first ',...
0768 'period length. This is applied as the covariance for both the sine and ',...
0769 'cosine term, assuming that the two terms are uncorrelated. That is, for ',...
0770 'single spectra retrievals, SX1 is a scalar, giving the variance for both ',...
0771 'a and b, where the baseline is modelled as a*sin(...)+b*cos(...). ',...
0772 'There shall be such a matrix for each period length until:',...
0773 '# ',...
0774 '#<SXn> Covariance matrix of a priori knowledge for last period length. ',...
0775 'The last required covariance matrix.',...
0776 '# ',...
0777 '#<L2> Flag for any function creating L2 data. See comments for ',...
0778 '*L2_EXTRA*. If set to true, the retrieved baseline variables ',...
0779 'will be included in the L2 output. Otherwise not. This field has no ',...
0780 'importance if RETRIEVE is false.'
0781 ];
0782 %-----------------------------------------------------------------------------
0783 Q.STOKES_DIM = {};
0784 I.STOKES_DIM = [ ...
0785 'As the arts WSV with the same name.'
0786 ];
0787 %-----------------------------------------------------------------------------
0788 Q.SURFACE_RTPROP_AGENDA = {};
0789 I.SURFACE_RTPROP_AGENDA = [ ...
0790 'As the arts WSV with the same name. WSMs are listed as an array of strings.'
0791 ];
0792 %-----------------------------------------------------------------------------
0793 Q.T = {};
0794 I.T = [ ...
0795 'Data and setting associated with atmospheric temperatures. Normally used ',...
0796 'when retrieving temperature. Otherwise, *T_FIELD* can be set directly.',...
0797 '# ',...
0798 '#<ATMDATA> The input shall follow the atmdata format, defined in ',...
0799 '*isatmdata*. The data specified here are not directly given to arts, it ',...
0800 'can only be used to set-up *T_FIELD*. This step is handled by ',...
0801 '*qarts_atm_field*. The main usage of this field should be to import ',...
0802 'data of climatology character. Can be given as a variable or a file saved ',...
0803 'through *gf_save*. ',...
0804 'This field is recognised and used automatically by Qpack2.',...
0805 '# ',...
0806 '#<RETRIEVE> If set to true, atmospheric temperatures are retrieved.', ...
0807 '# ',...
0808 '#<GRIDS> Retrieval grids for temperature. An array of vectors of length 3:',...
0809 ' {p_grid,lat_grid,lon_grid}. Grids for dimensions not used shall be ',...
0810 'empty.',...
0811 '# ',...
0812 '#<SX> Covariance matrix of a priori knowledge for temperature. Size must ',...
0813 'match the grid field. Data must match <UNIT>. A matrix, that can be ',...
0814 'sparse.',...
0815 '# ',...
0816 '#<L2> Flag for any function creating L2 data. See comments for ',...
0817 '*L2_EXTRA*. If set to true, the retrieved state for temperature ',...
0818 'will be included in the L2 output. Otherwise not.',...
0819 '# ',...
0820 '#<L2_RANGE>  As the same field for ABS_SPECIES.',...
0821 '# ',...
0822 '#<MINMAX> Min and max allowed value for retrievals. Works exactly as ',...
0823 'for ABS_SPECIES.',...
0824 '# ',...
0825 '#<HSE> As the argument to *jacobianAddTemperature* with same name. ',...
0826 'Default here is "on". This refers only to the actual jacobian calculation.',...
0827 ' If the atmosphere itself fulfils HSE or not is controlled by Q.HSE.',...
0828 '# ',...
0829 '#<METHOD> As the argument to *jacobianAddTemperature* with same name. ',...
0830 'Default here is "analytical".',...
0831 '# ',...
0832 '#<DT> As the argument to *jacobianAddTemperature* with same name. ',...
0833 'Default here is 1 K.',...
0834 '# ',...
0835 '#None of the fields are mandatory for pure forward calculations. If ',...
0836 'RETRIEVAL is set to false, the other retrieval related fields are ignored.'
0837 ];  
0838 %-----------------------------------------------------------------------------
0839 Q.T_FIELD = {};
0840 I.T_FIELD = [ ...
0841 'As the arts WSV with the same name. Will replace temperature data inserted',...
0842 ' through RAW_ATMOSPHERE.', ...
0843 '#   Can be given either as the name of a file, as a matching Matlab ',...
0844 'variable or control file text.'
0845 ];
0846 %-----------------------------------------------------------------------------
0847 Q.TNOISE_C = {};
0848 I.TNOISE_C = [ ...
0849 'Thermal noise correlation. A matrix (sparse preferably) giving the ', ...
0850 'correlation of thermal noise between channels. Hence, the diagonal ',...
0851 'elements shall all be one. If the thermal noise is the same for all ',...
0852 'channels and has a standard deviation of s, the covariance matrix is ',...
0853 's*s*TNOISE_C.'
0854 ];
0855 %-----------------------------------------------------------------------------
0856 Q.TRANSMITTER_POS = {};
0857 I.TRANSMITTER_POS = [ ...
0858 'As the arts WSV with the same name.', ...
0859 '#   Can be given either as the name of a file, as a matching Matlab ',...
0860 'variable or control file text.'
0861 ];
0862 %-----------------------------------------------------------------------------
0863 Q.VMR_NEGATIVE_OK = {};
0864 I.VMR_NEGATIVE_OK = [ ...
0865 'Corresponds directly to the argument *negative_vmr_ok* of ',...
0866 '*atmfields_checkedCalc*. Default is false, and only needed if you want ',...
0867 'to the flag to true.'
0868 ];
0869 %-----------------------------------------------------------------------------
0870 Q.VMR_FIELD = {};
0871 I.VMR_FIELD = [ ...
0872 'As the arts WSV with the same name. Will replace VMR data inserted ',...
0873 'through RAW_ATMOSPHERE.', ...
0874 '#   Can be given either as the name of a file, as a matching Matlab ',...
0875 'variable or control file text.',...
0876 '#   For retrievals, the a priori state for *ABS_SPECIES* is determined ',...
0877 'by this field.'
0878 ];
0879 %-----------------------------------------------------------------------------
0880 Q.WIND_U = {};
0881 I.WIND_U = [ ...
0882 'Data and settings associated with the u-component of winds. Normally used ',...
0883 'when retrieving winds. Otherwise, *WIND_U_FIELD* can be set directly.',...
0884 '# ',...
0885 '#<ATMDATA> The input shall follow the atmdata format, defined in ',...
0886 '*isatmdata*. The data specified here are not directly given to arts, it ',...
0887 'can only be used to set-up *WIND_U_FIELD*. This step is handled by ',...
0888 '*qarts_atm_field*. The main usage of this field should be to import ',...
0889 'data of climatology character. Can be given as a variable or a file saved ',...
0890 'through *gf_save*. ',...
0891 'This field is recognised and used automatically by Qpack2.',...
0892 '# ',...
0893 '#<RETRIEVE> If set to true, this atmospheric wind is retrieved.', ...
0894 '# ',...
0895 '#<GRIDS> Retrieval grids for the wind. An array of vectors of length 3:',...
0896 ' {p_grid,lat_grid,lon_grid}. Grids for dimensions not used shall be ',...
0897 'empty.',...
0898 '# ',...
0899 '#<SX> Covariance matrix of a priori knowledge for temperature. Size must ',...
0900 'match the grid field. Data must match <UNIT>. A matrix, that can be ',...
0901 'sparse.',...
0902 '# ',...
0903 '#<L2> Flag for any function creating L2 data. See comments for ',...
0904 '*L2_EXTRA*. If set to true, the retrieved state for this wind component ',...
0905 'will be included in the L2 output. Otherwise not.',...
0906 '# ',...
0907 '#<L2_RANGE>  As the same field for ABS_SPECIES.',...
0908 '# ',...
0909 '#None of the fields are mandatory for pure forward calculations. If ',...
0910 'RETRIEVAL is set to false, the other retrieval related fields are ignored.'
0911 ];  
0912 %-----------------------------------------------------------------------------
0913 Q.WIND_U_FIELD = {};
0914 I.WIND_U_FIELD = [ ...
0915 'As the arts WSV with the same name. Can be set to [].', ...
0916 '#   Can be given either as the name of a file, as a matching Matlab ',...
0917 'variable or control file text.'
0918 ];
0919 %-----------------------------------------------------------------------------
0920 Q.WIND_V = {};
0921 I.WIND_V = [ ...
0922 'Data and settings associated with the v-component of winds. Defined ',...
0923 'as WIND_U, and the details are nor repeated here.'
0924 ];
0925 %-----------------------------------------------------------------------------
0926 Q.WIND_V_FIELD = {};
0927 I.WIND_V_FIELD = [ ...
0928 'As the arts WSV with the same name. Can be set to [].', ...
0929 '#   Can be given either as the name of a file, as a matching Matlab ',...
0930 'variable or control file text.'
0931 ];
0932 %-----------------------------------------------------------------------------
0933 Q.WIND_W = {};
0934 I.WIND_W = [ ...
0935 'Data and settings associated with the w-component of winds. Defined ',...
0936 'as WIND_U, and the details are nor repeated here.'
0937 ];
0938 %-----------------------------------------------------------------------------
0939 Q.WIND_W_FIELD = {};
0940 I.WIND_W_FIELD = [ ...
0941 'As the arts WSV with the same name. Can be set to [].', ...
0942 '#   Can be given either as the name of a file, as a matching Matlab ',...
0943 'variable or control file text.'
0944 ];
0945 %-----------------------------------------------------------------------------
0946 Q.WSMS_AT_END = {};
0947 I.WSMS_AT_END = [ ...
0948 'Workspace method calls to include at the far end of the control file. ',...
0949 'Format and options as for WSMS_AT_START.'
0950 ];
0951 %-----------------------------------------------------------------------------
0952 Q.WSMS_AT_START = {};
0953 I.WSMS_AT_START = [ ...
0954 'Workspace method calls to include at the top of the control file. These ',...
0955 'calls are only preceded by possible settings set by INCLUDES.',...
0956 '# Method calls are specified as an cell array of strings. For example, if ',...
0957 'no inclusion files are used, these calls could be useful to include',...
0958 '#   { ''VectorSet(abs_n2,[0.7808])'', ''abs_cont_descriptionInit'' }',...
0959 '#A simple if/else/end feature is supported, with the format shown below. ',...
0960 'The argument to the if-statement must be a field of Q that is a boolean. ',...
0961 'Nested if-statements are not allowed. An example:',...
0962 '#   <IF> J_DO',...
0963 '#    (something)',...
0964 '#   <ELSE>',...
0965 '#    (something else)',...
0966 '#   <END>',...
0967 '#That is, <IF>, <ELSE> and <END> are used as identifiers. The identifiers ',...
0968 'must start the line. For <ELSE> and <END>, the rest of the line must be ',...
0969 'empty.'
0970 ];
0971 %-----------------------------------------------------------------------------
0972 Q.WSMS_BEFORE_ATMSURF = {};
0973 I.WSMS_BEFORE_ATMSURF = [ ...
0974 'Workspace method calls to include just before setting up the atmosphere ',...
0975 'and the surface. That is, before consider e.g. Q.P_GRID, Q.T_FIELD, ',...
0976 'Q.Z_SURFACE. Format and options as for WSMS_AT_START.'
0977 ];
0978 %-----------------------------------------------------------------------------
0979 Q.WSMS_BEFORE_RTE = {};
0980 I.WSMS_BEFORE_RTE = [ ...
0981 'Workspace method calls to include just before execution of *YCALC_WSMS* ',...
0982 'or batch core part. Accordingly, this field is considered only if ',...
0983 'spectra are calculated (ignored for e.g. pure absorption calculations). ',...
0984 'Format and options as for WSMS_AT_START.'
0985 ];
0986 %-----------------------------------------------------------------------------
0987 Q.YCALC_WSMS = {};
0988 I.YCALC_WSMS = [ ...
0989 'Workspace method calls for performing radiative transfer calculations. ',...
0990 'The standard choice should be that this fields includes a call of *yCalc*.',... 
0991 ' There is no clear division between this field and *WSMS_BEFORE_RTE*, but ',...
0992 'for best flexibility this field should start with *yCalc* (or corresponding',...
0993 ' method), followed by post-processing not handled by other fields.',...
0994 '#   Accordingly, this field is considered only if spectra are calculated ',...
0995 '(ignored for e.g. pure absorption calculations). Format and options as ',...
0996 'for WSMS_AT_START.'
0997 ];
0998 %-----------------------------------------------------------------------------
0999 Q.Z = {};
1000 I.Z = [ ...
1001 'Data and settings associated with Z_FIELD. Has the same role as T with ',...
1002 'respect to T_FIELD, but as there are no retrievals associated with Z ',...
1003 'there is only one sub-field here:',...
1004 '# ',...
1005 '#<ATMDATA> The input shall follow the atmdata format, defined in ',...
1006 '*isatmdata*. The data specified here are not directly given to arts, it ',...
1007 'can only be used to set-up *Z_FIELD*. This step is handled by ',...
1008 '*qarts_atm_field*. The main usage of this field should be to import ',...
1009 'data of climatology character. Can be given as a variable or a file saved ',...
1010 'through *gf_save*. ',...
1011 'This field is recognised and used automatically by Qpack2.',...
1012 ];
1013 %-----------------------------------------------------------------------------
1014 Q.Z_FIELD = {};
1015 I.Z_FIELD = [ ...
1016 'As the arts WSV with the same name. Will replace altitude data inserted ',...
1017 'through RAW_ATMOSPHERE.', ...
1018 '#   Can be given either as the name of a file, as a matching Matlab ',...
1019 'variable or control file text.'
1020 ];
1021 %-----------------------------------------------------------------------------
1022 Q.Z_SURFACE = {};
1023 I.Z_SURFACE = [ ...
1024 'Surface altitude (above reference ellipsoid). As the arts WSV with the ',...
1025 'same name.', ...
1026 '#   Can be given either as the name of a file, as a matching Matlab ',...
1027 'variable or control file text.'
1028 ];
1029 %-----------------------------------------------------------------------------

Generated on Mon 15-Sep-2014 13:31:28 by m2html © 2005