Configuration File Reference¶
The snowplot’s configuration file is described in detail below. This information is all based on the master.ini file stored under the top level of the package.
For configuration file syntax information please visit http://inicheck.readthedocs.io/en/latest/
lyte_probe¶
add_average_column
If true will average together all the columns
Default: False
Type: bool
assumed_depth
Depth in cm to assumed a linear depth profile to with the timeseries data
Default: None
Type: int
autocrop
Use the probes accelerometer and NIR sensors to crop the data to the snowpack only
Default: False
Type: bool
bottom_depth
Depth in CM where the movement stopped
Default: None
Type: float
calibration_coefficients
Polynomial coefficients to use for processing the column_to_plot data
Default: 1 0
Type: float
column_to_plot
List of columns to plot in the data
Default: sensor1
Type: string
depth_method
Method to determine the depth profile
Default: baro
Type: string
Options:
baro acc avg
detect_surface
Use the NIR sensors to determine the location of the snow surface.
Default: False
Type: bool
filename
Filename to be plotted
Default: None
Type: criticalfilename
fill_color
Decimal RGB Color to use for the plot when fill is used
Default: 0 .455 .784 1
Type: float
fill_solid
Determines whether to fill in the profile solid to the y axis
Default: True
Type: bool
line_color
Decimal RGB Color to use for the plot
Default: 0.0 0.0 0.0 1
Type: float
plot_id
Location of plot left to right starting with 1
Default: 1
Type: int
plot_labels
a list of tuples containing labels to add to the plot
Default: None
Type: string
problem_layer
Depth in centimeters to place a red horizontal line on the plot.
Default: None
Type: float
remove_xticks
Whether or not to use the xtick labels
Default: False
Type: bool
smoothing
Rolling window over each column to apply an averaging filter
Default: None
Type: int
surface_depth
Depth in CM where the snow surface begins in the profile. This will also shift your profile up such that this depth is now zero
Default: None
Type: float
title
Plot title for the Lyte probe
Default: lyte probe
Type: string
use_filename_title
Use the filename to for the lyte plot title
Default: True
Type: bool
xlabel
Label to put under the x axis
Default: Force (mN)
Type: string
xlimits
Range in the X Axis to plot after all the settings above are applied
Default: None
Type: floatpair
ylabel
Label on the y axis
Default: Depth from surface (cm)
Type: string
ylimits
Range of depths in cm to plot after all the settings above are applied
Default: None
Type: floatpair
snow_micropen¶
filename
Filename to be plotted
Default: None
Type: criticalfilename
fill_color
Decimal RGB Color to use for the plot
Default: 0.211 .27 .31 1
Type: float
fill_solid
Determines whether to fill in the profile solid to the y axis
Default: True
Type: bool
line_color
Default: 0.0 0.0 0.0 1
Type: float
plot_id
Location of plot left to right starting with 1
Default: 1
Type: int
plot_labels
a list of tuples containing labels to add to the plot
Default: None
Type: string
problem_layer
Depth in centimeters to place a red horizontal line on the plot.
Default: None
Type: float
remove_xticks
Whether or not to use the xtick labels
Default: False
Type: bool
smoothing
Rolling window over each column to apply an averaging filter
Default: None
Type: int
title
Plot title the snow micro pen
Default: snow micropen
Type: string
use_filename_title
Use the filename to for the SMP title
Default: True
Type: bool
xlabel
Label to put under the x axis
Default: Force (mN)
Type: string
xlimits
Range in the X Axis to plot after all the settings above are applied
Default: None
Type: floatpair
ylabel
Label on the y axis
Default: Depth from surface (cm)
Type: string
ylimits
Range of depths in cm to plot after all the settings above are applied
Default: None
Type: floatpair
hand_hardness¶
filename
Filename to be plotted
Default: None
Type: criticalfilename
fill_color
Decimal RGB Color to fill the plot if fill is used
Default: 0.603 0.6 0.84 1
Type: float
line_color
Default: 0.0 0.0 0.0 1
Type: float
plot_id
Location of plot left to right starting with 1
Default: 1
Type: int
plot_labels
a list of tuples containing labels to add to the plot
Default: None
Type: string
problem_layer
Depth in centimeters to place a red horizontal line on the plot.
Default: None
Type: float
remove_xticks
Whether or not to use the xtick labels
Default: False
Type: bool
title
Plot title for the hand hardness profile
Default: Hand Hardness
Type: string
use_filename_title
Use the filename to for the subplot title
Default: False
Type: bool
xlabel
Label to put under the x axis
Default: Hand Hardness
Type: string
xlimits
Range in the X Axis to plot after all the settings above are applied
Default: 0 19
Type: floatpair
ylabel
Label on the y axis
Default: Depth from surface (cm)
Type: string
ylimits
Range of depths in cm to plot after all the settings above are applied
Default: None
Type: floatpair
grain_size¶
filename
Filename to be plotted
Default: None
Type: criticalfilename
fill_color
Decimal RGB Color to fill the plot if fill is used
Default: 0.635 0.278 0.690
Type: float
line_color
Default: 0.0 0.0 0.0 1
Type: float
plot_id
Location of plot left to right starting with 1
Default: 1
Type: int
plot_labels
a list of tuples containing labels to add to the plot
Default: None
Type: string
problem_layer
Depth in centimeters to place a red horizontal line on the plot.
Default: None
Type: float
remove_xticks
Whether or not to use the xtick labels
Default: False
Type: bool
title
Plot title for the hand hardness profile
Default: Grain Size
Type: string
use_filename_title
Use the filename to for the subplot title
Default: False
Type: bool
xlabel
Label to put under the x axis
Default: Observed Grain Size
Type: string
xlimits
Range in the X Axis to plot after all the settings above are applied
Default: 0 5
Type: floatpair
ylabel
Label on the y axis
Default: Depth from surface (cm)
Type: string
ylimits
Range of depths in cm to plot after all the settings above are applied
Default: None
Type: floatpair
output¶
dpi
Resolution of the image to produce
Default: 100
Type: int
figure_size
Must be a list of two items specifying figure size in inches
Default: 6 10
Type: float
filename
filename for the outputted figure
Default: None
Type: string
output_dir
Location to save figures
Default: ./output
Type: directory
show_plot
Show the plot to be outputted
Default: True
Type: bool
suptitle
Over arching title on the figure.
Default: None
Type: string