6.35. `output.nml`¶

This file contains a variable number of namelists that are used to specify the output required by the user. The namelist JULES_OUTPUT should occur only once at the top of the file. The value of nprofiles in JULES_OUTPUT then determines how many times the namelist JULES_OUTPUT_PROFILE should appear.

6.35.1. `JULES_OUTPUT` namelist members¶

JULES_OUTPUT::output_dir¶

Type:	character
Default:	None

The directory used for output files. This can be an absolute or relative path.

JULES_OUTPUT::run_id¶

Type:	character
Default:	None

A name or identifier for the run. This is used to name output files and model dumps.

JULES_OUTPUT::nprofiles¶

Type:	integer
Permitted:	>= 0
Default:	0

The number of output profiles that will be specified using instances of the JULES_OUTPUT_PROFILE namelist.

JULES_OUTPUT::dump_period¶

Type:	integer
Permitted:	>= 1
Default:	1

The period between model dumps, unit depends on dump_period_unit.

In calendar year mode, the number of years between model dumps. Note that the calendar year (date) is used to determine whether a dump is written, not the number of years simulated so far. For example, a run that starts in the year 2012 and with dump_period = 5 will write dumps at the start of years 2015, 2020, 2025,…

In second of calendar day mode, the number of seconds between model dumps. Note that this is calculated using the number of seconds into the day, not the number seconds simulated so far. For example, with dump_period_unit = ‘T’ and dump_period = 10800, a run will write dumps at T00:00, T03:00, T06:00, T09:00, T12:00, T15:00, T18:00 and T21:00 of a calendar day.

Dumps are also written at the start and end of the main run, and at the start of each cycle of any spin up.

JULES_OUTPUT::dump_period_unit¶

Type:	character(1)
Permitted:	‘Y’, ‘T’
Default:	‘Y’

The unit/mode for the model dump period setting dump_period. If dump_period_unit = ‘Y’, use calendar year mode (default) and dump_period is in number of years. If dump_period_unit = ‘T’, use second of calendar day mode and dump_period is in number of seconds.

6.35.2. `JULES_OUTPUT_PROFILE` namelist members¶

This namelist should occur nprofiles times. Each occurrence of this namelist contains information about a single output profile, as described in JULES output.

JULES_OUTPUT_PROFILE::profile_name¶

Type:	character
Default:	None

The name of the output profile.

This is used in file names and should be specified even if there is only one profile. The name for each profile should be unique to avoid overwriting data unintentionally.

Although any name can be used for a profile, the user may which to choose a name that reflects the variables in the file (e.g. ‘carbon’, ‘water’) or the data frequency (e.g. ‘daily’, ‘monthly’).

JULES_OUTPUT_PROFILE::l_land_frac¶

Type:	logical
Default:	F

Output gridbox land fraction to output profile.

Required to add gribox land fraction to profile for example to allow JULES output to drive another JULES model.

JULES_OUTPUT_PROFILE::file_period¶

Type:	integer
Permitted:	-3, -2, -1 or 0
Default:	0

The period for output files, i.e. the time interval during which all output goes to the same file.

Note

In all cases, output during spin-up goes into a separate file for each spin-up cycle and output during the main run goes into its own file(s).

This can be one of three values:

0: All output goes into the same file.
-1: Monthly files are produced (i.e. all output for a month goes into the same file).
-2: Annual files (calendar years) are produced.
-3: Daily files are produced.

Members used to specify the times that the profile will generate output

JULES_OUTPUT_PROFILE::output_spinup¶

Type:	logical
Default:	F

Determines whether the profile will provide output during model spin-up.

TRUE: Provide output during spin-up. Output is provided for the whole of the model spin-up. Output from each spin-up cycle goes into separate files.
FALSE: Do not provide any output during spin-up.

JULES_OUTPUT_PROFILE::output_main_run¶

Type:	logical
Default:	F

Determines whether the profile will provide output during the main model run (i.e. any part of the run after spin-up).

TRUE: Provide output during the main model run. Output will be provided for all times between output_start and output_end below.
FALSE: Do not provide any output during the main model run.

JULES_OUTPUT_PROFILE::output_initial¶

Type:	logical
Default:	F

Determines whether the profile will output initial data for the sections for which it is outputting.

See Initial data for caveats on the initial data file(s) produced.

TRUE

Output initial data for the profile.

If output_spinup = T, an initial data file will be output at the start of each spinup cycle.

If output_main_run = T and output_start = main_run_start, an initial data file will be output at the start of the main run.

FALSE

Do not output any initial data.

JULES_OUTPUT_PROFILE::output_start¶

JULES_OUTPUT_PROFILE::output_end¶

Type:	character
Default:	`main_run_start`, `main_run_end`

The time to start and stop collecting data for output. The times that output is actually produced are determined by output_period below.

If output_period is monthly, then output_start must be 00:00:00 on the 1st of some month.

If output_period is yearly, then output_start must be 00:00:00 on the 1st of January for some year.

If output_end is given such that an output period is not complete when the run reaches output_end, output will not be generated for that final period (e.g. if values are being output monthly but output_end is midday on the 31st December, then output will not be generated for December, even though most of December has been run).

The times must be given in the format:

"yyyy-mm-dd hh:mm:ss"

JULES_OUTPUT_PROFILE::output_period¶

Type:	integer
Permitted:	-2, -1 or > 1
Default:	`timestep_len`

The period for output, in seconds. This controls the frequency with which output values are calculated; for time averages this is the length of time over which the average is calculated.

This must be a multiple of the timestep length, except for the special cases:

-1: Monthly period

-2: Annual period

JULES_OUTPUT_PROFILE::sample_period¶

Type:	integer
Permitted:	> 1
Default:	`timestep_len`

The sampling period, in seconds, for time-averages, minima, maxima and accumulations.

This must be a factor of output_period and a multiple of timestep_len. For the ‘special’ cases of output_period (e.g. monthly and annual outputs), one day must be a mutiple of sample_period.

output_period controls the length of time over which any statistic (e.g. an average) is calculated; sample_period controls how often values are sampled within that time to construct the statistic.

Note

It is strongly recommended that sample_period be left at the default value for most applications.

An example of when intermittent sampling can be useful is to construct a time average of values from particular timesteps, e.g. those on which a particular sub-model is called, for a variable that is reset to zero on other timesteps. Sampling every timestep will average over both the ‘good’ values and the zeros, whereas intermittent sampling can be used to pick up just the ‘good’ values. However, this is very rarely required with JULES.

Another use for intermittent sampling is to save computational cost (at the expense of losing accuracy), though in practice this is rarely required. In exceptional cases, sampling every timestep can be relatively expensive and acceptable output can be achieved by sampling less frequently. For example, with a large domain, many output diagnostics and a timestep of 30 minutes, a monthly average would be calculated from several hundred values if every timestep was used. For variables that evolve relatively slowly, an acceptable monthly average might be obtained by sampling only every 12 hours.

If fields are not sampled every timestep, the averages/minima/maxima/accumulations will only be approximations.

Members used to specify the variables that the profile will output

JULES_OUTPUT_PROFILE::nvars¶

Type:	integer
Permitted:	>= 0
Default:	0

The number of variables that the profile will provide output for.

The variables available for output are given in JULES Output variables.

JULES_OUTPUT_PROFILE::var¶

Type:	character(nvars)
Default:	None

List of variable names to output, as recognised by JULES (see JULES Output variables). Names are case sensitive.

JULES_OUTPUT_PROFILE::var_name¶

Type:	character(nvars)
Default:	‘’ (empty string)

For each variable specified in var, this is the name to give the variable in output files.

If the empty string (the default) is given for any variable, then the corresponding value from var is used instead.

JULES_OUTPUT_PROFILE::output_type¶

Type:	character(nvars)
Default:	‘S’

For each variable specified in var, this indicates the type of processing required.

Recognised values are:

S: Instantaneous or snapshot value.
M: Time mean value.
N: Time minimum value.
X: Time maximum value.
A: Accumulation over time.

For time average/minimum/maximum variables, the period over which each output value is calculated is given by output_period. For time-accumulation variables, output_period gives the period for output of an updated accumulation (i.e. how often the value is reported). For time averages, minima, maxima and accumulations, the sampling frequency is given by sample_period.

Note

A time-accumulation is initialised at the start of a run and thereafter accumulates until the end of the run. This may mean that accuracy is lost, particularly towards the end of long runs, if small increments are added to an already large sum. Furthermore, before being output the accumulation is multiplied by the number of model timesteps in a sample period. This adjusts the accumulation for any intermittent sampling and is designed so that the time accumulation of a flux (e.g. kg s^-1) can easily be converted to a total (e.g. kg) by subsequently multiplying by the model timestep length during post processing.

6.35.3. Example of requesting output¶

In this example, the user has requested two output profiles. One provides gridbox monthly means for the whole of the main run, the other provides snapshot values of per-tile variables every timestep for a single year. We assume that timestep_len = 1800, main_run_start = ‘1995-01-01 00:00:00’ and main_run_end = ‘2005-01-01 00:00:00’, so that exactly 10 years will be run. There is no spin-up.

&JULES_OUTPUT
  run_id = "jules_run001",

  output_dir = "./output",

  nprofiles = 2
/

&JULES_OUTPUT_PROFILE
  profile_name = "month",

  output_main_run = T,

  output_period = -1,

  nvars = 4,
  var         =    "emis_gb"        "ftl_gb"  "snow_mass_gb"  "tstar_gb",
  var_name    = "Emissivity"  "SensibleHeat"      "SnowMass"      "Temp",
  output_type =          'M'             'M'             'M'         'M'
/

&JULES_OUTPUT_PROFILE
  profile_name = "tstep",

  output_main_run = T,
  output_start    = "2000-01-01 00:00:00",
  output_end      = "2001-01-01 00:00:00",

  nvars = 4,
  var         = "emis"  "ftl"  "snow_mass"  "tstar",
  output_type =    'S'    'S'          'S'      'S'
/

Or using the alternative list syntax (see Introduction to Fortran namelists):

&JULES_OUTPUT
  # ... as above ...
/

&JULES_OUTPUT_PROFILE
  # ... as above ...

  nvars = 4,
  var(1) = "emis_gb",       var_name(1) = "Emissivity",    output_type(1) = 'M',
  var(2) = "ftl_gb",        var_name(2) = "SensibleHeat",  output_type(2) = 'M',
  var(3) = "snow_mass_gb",  var_name(3) = "SnowMass",      output_type(3) = 'M',
  var(4) = "tstar_gb",      var_name(4) = "Temp",          output_type(4) = 'M'
/

&JULES_OUTPUT_PROFILE
  # ... as above ...

  nvars = 4,
  var(1) = "emis",       output_type(1) = 'S',
  var(2) = "ftl",        output_type(2) = 'S',
  var(3) = "snow_mass",  output_type(3) = 'S',
  var(4) = "tstar",      output_type(4) = 'S'
/

The JULES_OUTPUT namelist is simple - it gives an id for the run, specifies the directory to put output in and specifies the number of profile definitions that follow.

Each profile is given a unique name. Both profiles want to output part of the main run, so must set output_main_run to TRUE. Since sample_period is not given for either profile, both will use the default (sample every timestep). The same is true for file_period - since it is not given for either profile, it takes its default value and all output for each profile will go into a single file.

The first output profile wants to output monthly averages, so output_period is set to -1 (the special value indicating that calendar months should be used for the output period) and output_type is set to ‘M’ (for mean) for each variable. The user wants this profile to output for the whole of the main run, so does not need to specify output_start or output_end (note that this is only possible because the main run starts at 00:00:00 on the 1st of a month - if this was not the case, the user would have to specify a different time for output_start). The user has also chosen to supply the names that each variable will use in output files using var_name.

The second output profile has specified a section of the main run that it will provide output for using output_start and output_end such that exactly a year of data will be output. Since output_period is not specified, it takes its default value, and output will be produced every timestep. The user has not specified the names to use in output files for this profile, so the values from var will be used.

6.35. `output.nml`¶

6.35.1. `JULES_OUTPUT` namelist members¶

6.35.2. `JULES_OUTPUT_PROFILE` namelist members¶

6.35.3. Example of requesting output¶

Table of Contents

Previous topic

Next topic

6.35. output.nml¶

6.35.1. JULES_OUTPUT namelist members¶

6.35.2. JULES_OUTPUT_PROFILE namelist members¶

6.35.3. Example of requesting output¶

6.35. `output.nml`¶

6.35.1. `JULES_OUTPUT` namelist members¶

6.35.2. `JULES_OUTPUT_PROFILE` namelist members¶