Configuration File Reference¶
The SMRF configuration file is described in detail below. This information is all based on the CoreConfig file stored under framework.
For configuration file syntax information please visit http://inicheck.readthedocs.io/en/latest/
topo¶
basin_lat
Latitude of the center of the basin used for sun angle calcs.
Default: None
Type: float
basin_lon
Longitude of the center of the basin used for sun angle calcs.
Default: None
Type: float
dem
File containing the DEM information
Default: None
Type: criticalfilename
filename
A net cdf file containing all veg info and dem.
Default: None
Type: criticalfilename
mask
Specifies the input file type
Default: None
Type: criticalfilename
roughness
specifies the file containing surface roughness length in m in ipw format
Default: None
Type: criticalfilename
threading
Specify whether the viewf and gradient calculations are threaded in loadTopo when initializing SMRF.
Default: true
Type: bool
type
Specifies the input file type
Default: netcdf
Type: string
Options:
netcdf ipw
veg_height
specifies the file containing vegetation height in ipw format
Default: None
Type: criticalfilename
veg_k
Default: None
Type: criticalfilename
veg_tau
Default: None
Type: criticalfilename
veg_type
Path to the file containing vegetation type in ipw format
Default: None
Type: criticalfilename
time¶
end_date
Date to end the data distribution
Default: None
Type: datetime
start_date
Date to start the data distribution
Default: None
Type: datetime
time_step
Time interval that SMRF distributes data at in minutes
Default: 60
Type: int
time_zone
Time zone for all times provided and how the model will be run see pytz docs for information on what is accepted
Default: UTC
Type: string
stations¶
check_colocation
check if stations are colocated in the same pixel This will not work if stations are outside of the model domain
Default: true
Type: bool
client
Clients available on the server to use that are a collection of station names
Default: None
Type: string
stations
Stations to be used in distributing any data
Default: None
Type: station
csv¶
air_temp
Path to CSV containing the station measured air temperature
Default: None
Type: criticalfilename
cloud_factor
Path to CSV containing the station measured cloud factor
Default: None
Type: criticalfilename
metadata
Path to CSV containing the station metadata
Default: None
Type: criticalfilename
precip
Path to CSV containing the station measured precipitation
Default: None
Type: criticalfilename
vapor_pressure
Path to CSV containing the station measured vapor pressure
Default: None
Type: criticalfilename
wind_direction
Path to CSV containing the station measured wind direction
Default: None
Type: criticalfilename
wind_speed
Path to CSV containing the station measured wind speed
Default: None
Type: criticalfilename
mysql¶
air_temp
name of the table column containing station air temperature
Default: air_temp
Type: string
cloud_factor
name of the table column containing station cloud factor
Default: cloud_factor
Type: string
data_table
name of the database table containing station data
Default: tbl_level2
Type: string
database
name of the database containing station data
Default: weather_db
Type: string
host
IP address to server.
Default: None
Type: string
metadata
name of the database table containing station metadata
Default: tbl_metadata
Type: string
password
password used for database login.
Default: None
Type: string
port
Port to use for logging into a db.
Default: 3606
Type: int
precip
name of the table column containing station precipitation
Default: precip_accum
Type: string
solar
name of the table column containing station solar radiation
Default: solar_radiation
Type: string
station_table
name of the database table containing client and source
Default: tbl_stations
Type: string
user
username for database login.
Default: None
Type: string
vapor_pressure
name of the table column containing station vapor pressure
Default: vapor_pressure
Type: string
wind_direction
name of the table column containing station wind direction
Default: wind_direction
Type: string
wind_speed
name of the table column containing station wind speed
Default: wind_speed
Type: string
gridded¶
data_type
Format of the outputted data
Default: wrf
Type: string
Options:
wrf hrrr netcdf
directory
Path to the top level directory where multiple gridded dataset live
Default: None
Type: criticaldirectory
file
Path to the netcdf file containing wrf data
Default: None
Type: criticalfilename
forecast_flag
if the gridded data is forecast or not
Default: False
Type: bool
n_forecast_hours
number of hours to forecast with hrrr
Default: 18
Type: int
zone_letter
For converting latitude and longitude to X and Y UTM coordinates
Default: None
Type: string
zone_number
For converting latitude and longitude to X and Y UTM coordinates
Default: None
Type: int
air_temp¶
The air_temp section controls all the available parameters that effect the distribution of the air_temp module, espcially the associated models. For more detailed information please see smrf.distribute.air_temp
| anisotropy_angle
| CCW angle (in degrees) by which to rotate coordinate system in order to take into account anisotropy.
| Default: 0.0
| Type: float
|
anisotropy_scaling
Scalar stretching value for kriging to take into account anisotropy.
Default: 1.0
Type: float
coordinates_type
Determines if the x and y coordinates are interpreted as on a plane (euclidean) or as coordinates on a sphere (geographic).
Default: euclidean
Type: string
Options:
euclidean geographic
detrend
Whether to detrend the distribution process
Default: true
Type: bool
distribution
Distribution method to use for this variable
Default: idw
Type: string
Options:
dk idw grid kriging
dk_nthreads
Number of threads to use in the dk calculation
Default: 1
Type: int
grid_local
Use local elevation gradients in gridded interpolation
Default: False
Type: bool
grid_local_n
number of closest grid cells to use for calcualting elevation gradient
Default: 25
Type: int
grid_method
interpolation method to use for this variable
Default: cubic
Type: string
Options:
nearest linear cubic
krig_weight
Flag that specifies if the kriging semivariance at smaller lags should be weighted more heavily when automatically calculating variogram model.
Default: False
Type: bool
mask
Mask the distribution calculations
Default: True
Type: bool
max
Maximum possible for this variable
Default: 47.0
Type: float
min
Minimum possible this variable
Default: -73.0
Type: float
nlags
Number of averaging bins for the kriging semivariogram
Default: 6
Type: int
power
Power for decay of a stations influence in inverse distance weighting
Default: 2.0
Type: float
regression_method
Polyfit order to use when using detrended kriging
Default: 1
Type: int
Options:
1
slope
if detrend is true constrain the slope to positive (1) or negative (-1) or no constraint (0)
Default: -1
Type: int
Options:
-1 0 1
stations
Stations to use for distributing this variable
Default: None
Type: station
variogram_model
Specifies which kriging variogram model to use
Default: linear
Type: string
Options:
linear power gaussian spherical exponential hole-effect
vapor_pressure¶
The vapor_pressure section controls all the available parameters that effect the distribution of the vapor_pressure module, espcially the associated models. For more detailed information please see smrf.distribute.vapor_pressure
| anisotropy_angle
| CCW angle (in degrees) by which to rotate coordinate system in order to take into account anisotropy.
| Default: 0.0
| Type: float
|
anisotropy_scaling
Scalar stretching value for kriging to take into account anisotropy.
Default: 1.0
Type: float
coordinates_type
Determines if the x and y coordinates are interpreted as on a plane (euclidean) or as coordinates on a sphere (geographic).
Default: euclidean
Type: string
Options:
euclidean geographic
detrend
Whether to detrend the distribution process
Default: true
Type: bool
distribution
Distribution method to use for this variable
Default: idw
Type: string
Options:
dk idw grid kriging
dk_nthreads
Number of threads to use in the dk calculation
Default: 1
Type: int
grid_local
Use local elevation gradients in gridded interpolation
Default: False
Type: bool
grid_local_n
number of closest grid cells to use for calcualting elevation gradient
Default: 25
Type: int
grid_method
interpolation method to use for this variable
Default: cubic
Type: string
Options:
nearest linear cubic
krig_weight
Flag that specifies if the kriging semivariance at smaller lags should be weighted more heavily when automatically calculating variogram model.
Default: False
Type: bool
mask
Mask the distribution calculations
Default: True
Type: bool
max
Maximum possible this variable
Default: 5000.0
Type: float
min
Minimum possible for this variable
Default: 10.0
Type: float
nlags
Number of averaging bins for the kriging semivariogram
Default: 6
Type: int
nthreads
Number of threads to use in the dew point calculation
Default: 2
Type: int
power
Power for decay of a stations influence in inverse distance weighting
Default: 2.0
Type: float
regression_method
Polyfit order to use when using detrended kriging
Default: 1
Type: int
Options:
1
slope
if detrend is true constrain the slope to positive (1) or negative (-1) or no constraint (0)
Default: -1
Type: int
Options:
-1 0 1
stations
Stations to use for distributing this variable
Default: None
Type: station
tolerance
Solving criteria for the dew point calculation
Default: 0.01
Type: float
variogram_model
Specifies which kriging variogram model to use
Default: linear
Type: string
Options:
linear power gaussian spherical exponential hole-effect
wind¶
The wind section controls all the available parameters that effect the distribution of the wind module, espcially the associated models. For more detailed information please see smrf.distribute.wind
| anisotropy_angle
| CCW angle (in degrees) by which to rotate coordinate system in order to take into account anisotropy.
| Default: 0.0
| Type: float
|
anisotropy_scaling
Scalar stretching value for kriging to take into account anisotropy.
Default: 1.0
Type: float
coordinates_type
Determines if the x and y coordinates are interpreted as on a plane (euclidean) or as coordinates on a sphere (geographic).
Default: euclidean
Type: string
Options:
euclidean geographic
detrend
Whether to detrend the distribution process
Default: False
Type: bool
distribution
Distribution method to use for this variable
Default: idw
Type: string
Options:
dk idw grid kriging
dk_nthreads
Number of threads to use in the dk calculation
Default: 2
Type: int
grid_local
Use local elevation gradients in gridded interpolation
Default: False
Type: bool
grid_local_n
number of closest grid cells to use for calcualting elevation gradient
Default: 25
Type: int
grid_method
interpolation method to use for this variable
Default: linear
Type: string
Options:
nearest linear cubic
krig_weight
Flag that specifies if the kriging semivariance at smaller lags should be weighted more heavily when automatically calculating variogram model.
Default: False
Type: bool
mask
Mask the distribution calculations
Default: True
Type: bool
max
Maximum possible this variable
Default: 35.0
Type: float
maxus_netcdf
NetCDF file containing the maxus values for wind
Default: None
Type: criticalfilename
min
Minimum possible for this variable
Default: 0.447
Type: float
nlags
Number of averaging bins for the kriging semivariogram
Default: 6
Type: int
peak
Name of stations that lie on a peak or a high point
Default: None
Type: string
power
Power for decay of a stations influence in inverse distance weighting
Default: 2.0
Type: float
reduction_factor
If wind speeds are still off here is a scaling factor
Default: 0.7
Type: float
regression_method
Polyfit order to use when using detrended kriging
Default: 1
Type: int
Options:
1
slope
if detrend is true constrain the slope to positive (1) or negative (-1) or no constraint (0)
Default: 1
Type: int
Options:
-1 0 1
station_default
Applies the value to all stations not specified
Default: 11.4
Type: float
stations
Stations to use for distributing this variable
Default: None
Type: station
variogram_model
Specifies which kriging variogram model to use
Default: linear
Type: string
Options:
linear power gaussian spherical exponential hole-effect
veg_3011
Applies the value where vegetation equals 3011(Rocky Mountain aspen)
Default: 3.3
Type: float
veg_3061
Applies the value where vegetation equals 3061(mixed aspen)
Default: 3.3
Type: float
veg_41
Applies the value where vegetation equals 41
Default: 3.3
Type: float
veg_42
Applies the value where vegetation equals 42
Default: 3.3
Type: float
veg_43
Applies the value where vegetation equals 43
Default: 11.4
Type: float
veg_default
Applies the value to all vegetation not specified
Default: 0.0
Type: float
wind_ninja_dir
Location in which the ascii files are output from the WindNinja simulation. This serves as a trigger for checking for WindNinja files.
Default: None
Type: criticaldirectory
wind_ninja_dxy
grid spacing at whcih the WindNinja ascii files are output.
Default: None
Type: int
wind_ninja_height
the output height of wind fileds from WindNinja in meters.
Default: 5.0
Type: string
wind_ninja_pref
prefix of all outputs from WindNinja that matches the topo input to WindNinja.
Default: None
Type: string
wind_ninja_roughness
the surface roughness used in WindNinja generally grass.
Default: 0.01
Type: string
wind_ninja_tz
Time zone that from the WindNinja config.
Default: Europe/London
Type: string
precip¶
The precipitation section controls all the available parameters that effect the distribution of the precipitation module, espcially the associated models. For more detailed information please see smrf.distribute.precipitation
| adjust_for_undercatch
| Apply undercatch relationships to precip gauges
| Default: true
| Type: bool
|
anisotropy_angle
CCW angle (in degrees) by which to rotate coordinate system in order to take into account anisotropy.
Default: 0.0
Type: float
anisotropy_scaling
Scalar stretching value for kriging to take into account anisotropy.
Default: 1.0
Type: float
catchment_model_default
WMO model used to adjust precip for undercatch of precip
Default: us_nws_8_shielded
Type: string
Options:
us_nws_8_shielded us_nws_8_unshielded
coordinates_type
Determines if the x and y coordinates are interpreted as on a plane (euclidean) or as coordinates on a sphere (geographic).
Default: euclidean
Type: string
Options:
euclidean geographic
detrend
Whether to detrend the distribution process
Default: true
Type: bool
distribute_drifts
redistribute precip based on wind
Default: false
Type: bool
distribution
Distribution method to use for this variable
Default: dk
Type: string
Options:
dk idw grid kriging
dk_nthreads
Number of threads to use in the dk calculation
Default: 2
Type: int
drift_poly_a
first coefficient for drift factor function
Default: 0.0289
Type: float
drift_poly_b
second coefficient for drift factor function
Default: -0.0956
Type: float
drift_poly_c
third coefficient for drift factor function
Default: 1.000761
Type: float
grid_local
Use local elevation gradients in gridded interpolation
Default: False
Type: bool
grid_local_n
number of closest grid cells to use for calcualting elevation gradient
Default: 25
Type: int
grid_method
interpolation method to use for this variable
Default: cubic
Type: string
Options:
nearest linear cubic
krig_weight
Flag that specifies if the kriging semivariance at smaller lags should be weighted more heavily when automatically calculating variogram model.
Default: False
Type: bool
mask
Mask the distribution calculations
Default: True
Type: bool
max
Maximum possible this variable
Default: None
Type: float
max_drift
max multiplier for precip redistribution in a drift cell
Default: 3.5
Type: float
max_scour
max multiplier for precip redistribution to account for wind scour
Default: 1.0
Type: float
min
Minimum possible for this variable
Default: 0.0
Type: float
min_drift
min multiplier for precip redistribution in a drift cell
Default: 1.0
Type: float
min_scour
minimum multiplier for precip redistribution to account for wind scour
Default: 0.55
Type: float
nasde_model
Method to use for calculating the new snow density
Default: marks2017
Type: string
Options:
marks2017 susong1999 piecewise_susong1999
nlags
Number of averaging bins for the kriging semivariogram
Default: 6
Type: int
power
Power for decay of a stations influence in inverse distance weighting
Default: 2.0
Type: float
ppt_poly_a
firstcoefficient for scour factor function
Default: 0.0001737
Type: float
ppt_poly_b
second coefficient for scour factor function
Default: 0.002549
Type: float
ppt_poly_c
thirdcoefficient for scour factor function
Default: 0.03265
Type: float
ppt_poly_d
coefficient for scour factor function
Default: 0.5929
Type: float
precip_temp_method
which variable to use for precip temperature
Default: dew_point
Type: string
Options:
dew_point wet_bulb
regression_method
Polyfit order to use when using detrended kriging
Default: 1
Type: int
Options:
1
slope
if detrend is true constrain the slope to positive (1) or negative (-1) or no constraint (0)
Default: 1
Type: int
Options:
-1 0 1
stations
Stations to use for distributing this variable
Default: None
Type: station
storm_days_restart
Path to netcdf representing the last storm days so a run can continue in between stops
Default: None
Type: criticalfilename
storm_mass_threshold
Start criteria for a storm in mm of measured precip
Default: 1.0
Type: float
tbreak_netcdf
NetCDF file containing the tbreak values for wind
Default: None
Type: filename
tbreak_threshold
Threshold for drift cells measured in degrees from tbreak file
Default: 7.0
Type: float
time_steps_to_end_storms
number of timesteps to elapse with precip under start criteria before ending a storm
Default: 6
Type: int
variogram_model
Specifies which kriging variogram model to use
Default: linear
Type: string
Options:
linear power gaussian spherical exponential hole-effect
veg_3011
Interference inverse factor for precip redistribution where vegetation equals 3011(Rocky Mountain Aspen)
Default: 0.7
Type: float
veg_3061
Interference inverse factor for precip redistribution where vegetation equals 3061(Mixed Aspen)
Default: 0.7
Type: float
veg_41
Interference inverse factor for precip redistribution where vegetation equals 41
Default: 0.7
Type: float
veg_42
Interference inverse factor for precip redistribution where vegetation equals 42
Default: 0.7
Type: float
veg_43
Interference inverse factor for precip redistribution where vegetation equals 43
Default: 0.7
Type: float
veg_default
Applies the value to all vegetation not specified
Default: 1.0
Type: float
albedo¶
The albedo section controls all the available parameters that effect the distribution of the albedo module, espcially the associated models. For more detailed information please see smrf.distribute.albedo
| decay_method
| Describe how the albedo decays in the late season
| Default: None
| Type: string
| Options:
- hardy2000 date_method None*
decay_power
Exponent value of the decay rate equation prescribed by the method.
Default: 0.714
Type: float
dirt
Effective contamination for adjustment to visible albedo (usually between 1.5-3.0)
Default: 2.0
Type: float
end_decay
Starting date for applying the decay method described by date_method
Default: None
Type: datetime
grain_size
Effective grain radius of snow after last storm (mu m)
Default: 300.0
Type: float
grid_method
interpolation method to use for this variable
Default: cubic
Type: string
Options:
nearest linear cubic
litter_41
Litter rate for Veg type 41
Default: 0.006
Type: float
litter_42
Litter rate for Veg type 42
Default: 0.006
Type: float
litter_43
Litter rate for Veg type 43
Default: 0.003
Type: float
litter_albedo
albedo of the litter on the snow using the hard method
Default: 0.2
Type: float
litter_default
Litter rate for places where vegetation not specified
Default: 0.003
Type: float
mask
Mask the distribution calculations
Default: True
Type: bool
max
Maximum possible this variable
Default: 1.0
Type: float
max_grain
Max grain radius of snow possible
Default: 2000.0
Type: float
min
Minimum possible for this variable
Default: 0.0
Type: float
power
Power for decay of a stations influence in inverse distance weighting
Default: 2.0
Type: float
start_decay
Starting date for applying the decay method described by date_method
Default: None
Type: datetime
veg_41
Applies the value where vegetation equals 41
Default: 0.36
Type: float
veg_42
Applies the value where vegetation equals 42
Default: 0.36
Type: float
veg_43
Applies the value where vegetation equals 43
Default: 0.25
Type: float
veg_default
Applies the value to all vegetation not specified
Default: 0.25
Type: float
solar¶
The solar section controls all the available parameters that effect the distribution of the solar module, espcially the associated models. For more detailed information please see smrf.distribute.solar
| anisotropy_angle
| CCW angle (in degrees) by which to rotate coordinate system in order to take into account anisotropy.
| Default: 0.0
| Type: float
|
anisotropy_scaling
Scalar stretching value for kriging to take into account anisotropy.
Default: 1.0
Type: float
clear_gamma
Scattering asymmetry parameter
Default: 0.3
Type: float
clear_omega
Single-scattering albedo
Default: 0.85
Type: float
clear_opt_depth
Elevation of optical depth measurement
Default: 100.0
Type: float
clear_tau
Optical depth at z
Default: 0.2
Type: float
coordinates_type
Determines if the x and y coordinates are interpreted as on a plane (euclidean) or as coordinates on a sphere (geographic).
Default: euclidean
Type: string
Options:
euclidean geographic
correct_albedo
Multiply the solar radiation by 1-snow_albedo.
Default: true
Type: bool
correct_cloud
Multiply the solar radiation by the cloud factor derived by station data.
Default: true
Type: bool
correct_veg
Apply solar radiation corrections according to veg_type
Default: true
Type: bool
detrend
Whether to detrend the distribution process
Default: false
Type: bool
distribution
Distribution method to use for this variable
Default: idw
Type: string
Options:
dk idw grid kriging
dk_nthreads
Number of threads to use in the dk calculation
Default: 2
Type: int
grid_local
Use local elevation gradients in gridded interpolation
Default: False
Type: bool
grid_local_n
number of closest grid cells to use for calcualting elevation gradient
Default: 25
Type: int
grid_method
interpolation method to use for this variable
Default: cubic
Type: string
Options:
nearest linear cubic
krig_weight
Flag that specifies if the kriging semivariance at smaller lags should be weighted more heavily when automatically calculating variogram model.
Default: False
Type: bool
mask
Mask the distribution calculations
Default: True
Type: bool
max
Maximum possible this variable
Default: 800.0
Type: float
min
Minimum possible for this variable
Default: 0.0
Type: float
nlags
Number of averaging bins for the kriging semivariogram
Default: 6
Type: int
power
Power for decay of a stations influence in inverse distance weighting
Default: 2.0
Type: float
regression_method
Polyfit order to use when using detrended kriging
Default: 1
Type: int
Options:
1
slope
if detrend is true constrain the slope to positive (1) or negative (-1) or no constraint (0)
Default: 1
Type: int
Options:
-1 0 1
stations
Stations to use for distributing this variable
Default: None
Type: station
variogram_model
Specifies which kriging variogram model to use
Default: linear
Type: string
Options:
linear power gaussian spherical exponential hole-effect
thermal¶
The thermal section controls all the available parameters that effect the distribution of the thermal module, espcially the associated models. For more detailed information please see smrf.distribute.thermal
| cloud_method
| Method for adjusting radiation for cloud effects
| Default: garen2005
| Type: string
| Options:
garen2005 unsworth1975 kimball1982 crawford1999
correct_cloud
specify whether to use the cloud adjustments in thermal calculation
Default: true
Type: bool
correct_terrain
specifies whether to account for vegetation in the thermal calculations
Default: true
Type: bool
correct_veg
specifies whether to account for vegetation in the thermal calculations
Default: true
Type: bool
detrend
Whether to detrend the distribution process
Default: False
Type: bool
distribution
Distribution method to use for this variable. Thermal can only uses gridded interpolation for gridded datasets
Default: grid
Type: string
Options:
grid
grid_local
Use local elevation gradients in gridded interpolation
Default: False
Type: bool
grid_local_n
number of closest grid cells to use for calcualting elevation gradient
Default: 25
Type: int
grid_method
interpolation method to use for this variable
Default: cubic
Type: string
Options:
nearest linear cubic
mask
Mask the thermal radiation calculations
Default: True
Type: bool
max
Maximum possible this variable
Default: 600.0
Type: float
method
Method for calculating the thermal radiation
Default: marks1979
Type: string
Options:
marks1979 dilley1998 prata1996 angstrom1918
min
Minimum possible for this variable
Default: 0.0
Type: float
nthreads
Number of threads to use thermal radiation calcs when using Marks1979
Default: 2
Type: int
slope
if detrend is true constrain the slope to positive (1) or negative (-1) or no constraint (0)
Default: 0
Type: int
Options:
-1 0 1
soil_temp¶
The soil_temp section controls all the available parameters that effect the distribution of the soil_temp module, espcially the associated models. For more detailed information please see smrf.distribute.soil_temp
| temp
| constant value to use for the soil temperature.
| Default: -2.5
| Type: float
|
output¶
file_type
Format to use for outputting data.
Default: netcdf
Type: string
Options:
netcdf
frequency
Number of timesteps to output data.
Default: 1
Type: int
input_backup
Specify whether to backup the input data and create config file to run the smrf run from that backup.
Default: true
Type: bool
mask
Mask the final NetCDF output.
Default: False
Type: bool
out_location
Directory to output results
Default: None
Type: criticaldirectory
variables
Variables to output after being calculated.
Default: thermal air_temp vapor_pressure wind_speed wind_direction net_solar precip percent_snow snow_density precip_temp
Type: string
Options:
all air_temp albedo_vis albedo_ir precip percent_snow snow_density storm_days precip_temp clear_ir_beam clear_ir_diffuse clear_vis_beam clear_vis_diffuse cloud_factor cloud_ir_beam cloud_ir_diffuse cloud_vis_beam cloud_vis_diffuse net_solar veg_ir_beam veg_ir_diffuse veg_vis_beam veg_vis_diffuse thermal vapor_pressure dew_point flatwind wind_speed wind_direction storm_total thermal_clear thermal_veg thermal_cloud
logging¶
log_file
File path to a txt file for the log info to be outputted
Default: None
Type: filename
log_level
level of information to be logged
Default: debug
Type: string
Options:
debug info error
qotw
Default: false
Type: bool
system¶
max_values
How many timesteps that a calculation can get ahead while threading if it is independent of other variables.
Default: 2
Type: int
threading
Specify whether to use python threading in calculations.
Default: true
Type: bool
time_out
Amount of time to wait for a thread before timing out
Default: None
Type: float