Debian Codegraph @

doc/p_cmip5/configuration.rst

raw
1 The configuration file.
2 =======================
3
4 A configuration file is required by the p_cmip5 module (which assigns the data to DRS product=output1 or output2) for processing piControl data,
5 and may optionally contain additional information which will ensure consistency of of the assigment for some other datasets (details below).
6
7 The configuration file is in standard ini-file format and should contain one section for each model name you want to process. Within each section set of option name/value pairs are listed to specify relevant properties of the model.
8
9
10 An Example
11 ''''''''''
12
13 For instance the definition for 2 models ``HADCM3`` and ``HIGEM1-2`` could look as follows:
14
15 .. code-block:: ini
16
17 [HADCM3]
18
19 category=centennial
20 branch_year_piControl_to_historical=1820
21 base_year_historical=1850
22 branch_year_esmControl_to_esmHistorical=1850
23 base_year_esmHistorical=1850
24
25 [HIGEM1-2]
26
27 category=other
28 branch_year_piControl_to_historical=1820
29 base_year_historical=1850
30 branch_year_esmControl_to_esmHistorical=1850
31 base_year_esmHistorical=1850
32
33 Option names
34 ''''''''''''
35
36 1. category
37 -----------
38 :Value: either 'centennial' or 'other'
39 :Description:
40 The category specifies which suite of experiments the model is being used for.
41 This information is use to determine what data should be prioritised for quality control and DOI assignment.
42 The aim is to ensure consistency between experiments and between modelling groups.
43 If a model is used both for centennial and decadal experiments, specify 'centennial'.
44
45 2. branch_year_piControl_to_historical
46 --------------------------------------
47 :Value: integer
48 :Description:
49 The year of the piControl data used to initiate the historical run.
50
51 Required if piControl data for tables aero, day or 6hrPlev is
52 archived. This information can be determined from the global
53 attribute "branch" in the historical data files and the base year
54 from the time units of the piControl experiment.
55
56 3. base_year_historical
57 -----------------------
58 :Value: integer
59 :Description:
60 The year of the start of the historical run. This is required
61 becuase it is needed when processing piControl data, and thus cannot
62 generally be obtained from the data files being processed.
63
64 4. branch_year_esmControl_to_esmHistorical
65 ------------------------------------------
66 :Value: integer
67 :Description:
68 The year of the piControl data used to initiate the historical
69 run. See notes on 2. branch_year_piControl_to_historical
70
71 5. base_year_esmHistorical
72 --------------------------
73 :Value: integer
74 :Description: Start of esmHistorical expt. See notes on 3. base_year_historical
75
76 6. base_year_abrupt4xCO2 [optional]
77 -----------------------------------
78 :Value: integer
79 :Description:
80 The year of start of the abrupt4xCO2 run. Used for processing
81 abrupt4xCO2 data -- only needed if the base year specified by the
82 time units does not correspond to start of experiment.
83
84
85 7. base_year_piControl [optional]
86 ---------------------------------
87 :Value: integer
88 :Description:
89 The year of start of the piControl run. Only needed if the base year specified
90 by the time units does not correspond to start of experiment.
91
92 Used in determining which years of data from the aero table,
93 piControl experiment in the decadal suite are replicated.
94
95 8. base_year_1pctCO2 [optional]
96 -------------------------------
97 :Value: integer
98 :Description:
99 The year of start of the 1pctCO2 run. Only needed if the base year specified
100 by the time units does not correspond to start of experiment.
101
102