Usage: Settings

In BUVIC's Web Application, Settings can be changed by clicking on the Settings button. Settings are saved in a file called .buvic-settings.conf in the home directory.

For the command line app, setting files can be loaded with the option --config <setting_file_path> and, for the watchdog docker image TODO: link, a directory containing a setting file called settings.json can be mounted as volume at /config.

Available Settings

Field	Value	Default	Description
arf_column	Integer (1, 2, 3 or 4)	3	Column of the ARF file to use for the cos correction (column 0 is sza)
weighted_irradiance_type	Erythemal, Vitamin D3, UV, UV A or UV B	Erythemal	Type of weight function to use for the weighted irradiance in the daily UVER file
no_coscor	Boolean (true or false)	false	Cosine correction will not be applied if set to true
temperature_correction_factor	Float (e.g. 0.01)	0.0	The temperature correction factor C for temperature correction. Each value of the spectrum F for a temperature T (°C) will be corrected with a correction factor C and a reference temperature Tref (°C) with the formula: F * [1 + C * (T - Tref)]
temperature_correction_ref	Float (e.g. 0.01)	0.0	The reference temperature Tref (see temperature_correction_factor)
default_albedo	Float between 0.0 and 1.0 (e.g. 0.1)	0.04	The albedo to use if no value is found in the parameter file
default_aerosol	Json object with two fields: 1. alpha: Float 2. beta: Float	{ "alpha":1.3, "beta":0.1 }	The aerosol angstrom alpha and beta values to use if no value is found in the parameter file
default_ozone	Float (e.g. 296.21)	300.0	The Ozone (in DU) to use if no value is found in the B files
default_straylight_correction	Applied or Not applied	Applied	Whether to apply straylight correction. This value is used if the brewer model could not be retrieved from the B Files
uv_data_source	Files or EUBREWNET	Files	The data source for UV measurement
ozone_data_source	Files or EUBREWNET	Files	The data source for ozone
uvr_data_source	Files or EUBREWNET	Files	The data source for the calibration data
brewer_model_data_source	Files or EUBREWNET	Files	The data source for the brewer model (used to determine straylight correction)
activate_woudc	Boolean (true or false)	false	Whether to output a file in the WOUDC format
woudc_info	A WoudcInfo json object (see table below)		The custom info for the WOUDC output file

Woudc Info fields:

Field	Value	Default	Description
agency	String	""	The acronym of the submitting Agency
version	String	"1.0"	Data version specified by the submitting Agency. These versions have the form “major.minor” (e.g., 3.2) where major values are incremented with a./ changes to data file metadata or b./ the processing algorithm. Minor values are incremented when the characterisation or calibration values have changed. Note: minor values are reset to zero with changes to the processing algorithm.
scientific_authority	String	""	The person(s) responsible for the data quality at the submitting Agency.
platform_id	String	""	Unique station or flight ID assigned by the WOUDC to each registered platform.
platform_name	String	""	Platform Name (requested that an ASCII character name be used)
country_iso3	String	""	The country where the platform is located using the three-letter ISO-3166 code (e.g., Finland is FIN, Switzerland is CHE, etc.).
gaw_id	String	""	three-letter GAW ID as issued by GAWSIS, if available (recommended).
altitude	Integer (e.g. 1590)	0	The altitude, elevation, or height of the defined platform + instrument above sea level. Typically an instrument is located at a fixed location and shares the platform elevation. The format is metres above sea level (m.a.s.l.).

Setting files

The setting file content must have the following structure:

{
   "arf_column":3,
   "weighted_irradiance_type":"Erythemal",
   "no_coscor":false,
   "temperature_correction_factor":0.0,
   "temperature_correction_ref":0.0,
   "default_albedo":0.04,
   "default_aerosol":{
      "alpha":1.3,
      "beta":0.1
   
   },
   "default_ozone":300.0,
   "default_straylight_correction":"Applied",
   "uv_data_source":"Files",
   "ozone_data_source":"Files",
   "uvr_data_source":"Files",
   "brewer_model_data_source":"Files",
   "activate_woudc":false,
   "woudc_info":{
      "agency":"",
      "version":"1.0",
      "scientific_authority":"",
      "platform_id":"",
      "platform_name":"",
      "country_iso3":"",
      "gaw_id":"",
      "altitude":0
   }
}

Each one of the field is optional and you can without problem create a config file with just the parameters that you want. Example:

{
   "arf_column":2,
   "temperature_correction_factor":0.1,
   "temperature_correction_ref":20.0,
   "ozone_data_source":"EUBREWNET",
   "activate_woudc":true,
   "woudc_info":{
      "altitude":1590
   }
}