CLI Reference

hvsrpy

Command line interface to hvsrpy.

hvsrpy [OPTIONS] [FILE_NAMES]...

Options

--config <config>

Path to configuration file.

--windowlength <windowlength>

Length of time windows, default is 60 seconds.

--filter_bool <filter_bool>

Controls whether a bandpass filter is applied, default is False.

--filter_flow <filter_flow>

Low frequency limit of bandpass filter in Hz, default is 0.1.

--filter_fhigh <filter_fhigh>

High frequency limit of bandpass filter in Hz, default is 30.

--filter_order <filter_order>

Filter order, default is 5 (i.e., 5th order filter).

--width <width>

Length of cosine taper, default is 0.1 (5% on each side) of time window.

--bandwidth <bandwidth>

Bandwidth coefficient for Konno & Ohmachi (1998) smoothing, default is 40.

--resample_fmin <resample_fmin>

Minimum frequency in Hz to consider when resampling, defaults is 0.2.

--resample_fmax <resample_fmax>

Maximum frequency in Hz to consider when resampling, defaults is 20.

--resample_fnum <resample_fnum>

Number of samples in resampled curve, default is 128.

--resample_type <resample_type>

Type of resampling, default is ‘log’.

Options

log | linear

--peak_f_lower <peak_f_lower>

Lower frequency limit of peak selection, defaults to entire range.

--peak_f_upper <peak_f_upper>

Upper frequency limit of peak selection, defaults to entire range.

--method <method>

Method for combining the horizontal components, default is ‘geometric-mean’.

Options

squared-average | geometric-mean | single-azimuth | multiple-azimuths

--azimuth <azimuth>

Azimuth to orient horizontal components when method is ‘single-azimuth’, default is 0.

--azimuthal_interval <azimuthal_interval>

Interval in degrees between azimuths when method is ‘multiple-azimuths’, default is 15.

--rejection_bool <rejection_bool>

Determines whether the rejection is performed, default is True.

--n <n>

Number of standard deviations to consider when performing the rejection, default is 2.

--max_iterations <max_iterations>

Number of permitted iterations to convergence, default is 50.

--distribution_f0 <distribution_f0>

Distribution assumed to describe the fundamental site frequency, default is ‘lognormal’.

Options

lognormal | normal

--distribution_mc <distribution_mc>

Distribution assumed to describe the median curve, default is ‘lognormal’.

Options

lognormal | normal

--no_time

Flag to suppress HVSR compute time.

--no_figure

Flag to prevent figure creation.

--ymin <ymin>

Manually set the lower y limit of the HVSR figure.

--ymax <ymax>

Manually set the upper y limit of the HVSR figure.

--summary_type <summary_type>

Summary file format to save, default is ‘hvsrpy’.

Options

none | hvsrpy | geopsy

--nproc <nproc>

Number of subprocesses to launch, default is number of cpus minus 1.

Arguments

FILE_NAMES

Optional argument(s)