svtk plot

Command Tree

Command Details

Usage

svtk plot [-h] {metrics,spatial} ...

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

svtk plot metrics

Usage

svtk plot metrics [-h]
                      {list,band-score-distribution,boxplot,example-metric-pairs,geology-boxplot,heatmap,metric-trend,model-metric-heatmap,period-spectra,period-spectrogram,phase-delay-vs-distance,psa-period-curve,residuals-vs-depth,residuals-vs-distance,scatterplot,score-trends,vs30-scatter,winner-heatmap}
                      ...

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

svtk plot metrics band-score-distribution

Usage

svtk plot metrics band-score-distribution [-h] --input INPUT --output
                                              OUTPUT [--table TABLE]
                                              [--kwargs [KWARGS ...]]
                                              [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics boxplot

Usage

svtk plot metrics boxplot [-h] --input INPUT --output OUTPUT
                              [--table TABLE] [--kwargs [KWARGS ...]]
                              [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the data argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics example-metric-pairs

Usage

svtk plot metrics example-metric-pairs [-h] --output OUTPUT
                                           [--table TABLE]
                                           [--kwargs [KWARGS ...]]
                                           [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics geology-boxplot

Usage

svtk plot metrics geology-boxplot [-h] --input INPUT --output OUTPUT
                                      [--table TABLE]
                                      [--kwargs [KWARGS ...]]
                                      [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics heatmap

Usage

svtk plot metrics heatmap [-h] --input INPUT --output OUTPUT
                              [--table TABLE] [--kwargs [KWARGS ...]]
                              [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the data argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics list

Usage

svtk plot metrics list [-h]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

svtk plot metrics metric-trend

Usage

svtk plot metrics metric-trend [-h] --input INPUT --output OUTPUT
                                   [--table TABLE] [--kwargs [KWARGS ...]]
                                   [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics model-metric-heatmap

Usage

svtk plot metrics model-metric-heatmap [-h] --input INPUT --output
                                           OUTPUT [--table TABLE]
                                           [--kwargs [KWARGS ...]]
                                           [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the summary_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics period-spectra

Usage

svtk plot metrics period-spectra [-h] --input INPUT --output OUTPUT
                                     [--table TABLE]
                                     [--kwargs [KWARGS ...]]
                                     [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the spectra_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics period-spectrogram

Usage

svtk plot metrics period-spectrogram [-h] --input INPUT --output OUTPUT
                                         [--table TABLE]
                                         [--kwargs [KWARGS ...]]
                                         [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the spectrogram_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics phase-delay-vs-distance

Usage

svtk plot metrics phase-delay-vs-distance [-h] --input INPUT --output
                                              OUTPUT [--table TABLE]
                                              [--kwargs [KWARGS ...]]
                                              [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics psa-period-curve

Usage

svtk plot metrics psa-period-curve [-h] --input INPUT --output OUTPUT
                                       [--table TABLE]
                                       [--kwargs [KWARGS ...]]
                                       [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics residuals-vs-depth

Usage

svtk plot metrics residuals-vs-depth [-h] --input INPUT --output OUTPUT
                                         [--table TABLE]
                                         [--kwargs [KWARGS ...]]
                                         [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics residuals-vs-distance

Usage

svtk plot metrics residuals-vs-distance [-h] --input INPUT --output
                                            OUTPUT [--table TABLE]
                                            [--kwargs [KWARGS ...]]
                                            [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics scatterplot

Usage

svtk plot metrics scatterplot [-h] --input INPUT --output OUTPUT
                                  [--table TABLE] [--kwargs [KWARGS ...]]
                                  [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the data argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics vs30-scatter

Usage

svtk plot metrics vs30-scatter [-h] --input INPUT --output OUTPUT
                                   [--table TABLE] [--kwargs [KWARGS ...]]
                                   [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot metrics winner-heatmap

Usage

svtk plot metrics winner-heatmap [-h] --input INPUT --output OUTPUT
                                     [--table TABLE]
                                     [--kwargs [KWARGS ...]]
                                     [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the summary_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial

Usage

svtk plot spatial [-h]
                      {list,azimuthal-residuals,block-holdout-scatter,cluster-feature-heatmap,cluster-solution-scores,correlogram,directional-correlogram,path-bin-summary,pattern-similarity,pca-explained-variance,pca-feature-loadings,polar-residuals,residual-correlation,semivariogram}
                      ...

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

svtk plot spatial azimuthal-residuals

Usage

svtk plot spatial azimuthal-residuals [-h] --input INPUT --output
                                          OUTPUT [--table TABLE]
                                          [--kwargs [KWARGS ...]]
                                          [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial block-holdout-scatter

Usage

svtk plot spatial block-holdout-scatter [-h] --input INPUT --output
                                            OUTPUT [--table TABLE]
                                            [--kwargs [KWARGS ...]]
                                            [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the prediction_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial cluster-feature-heatmap

Usage

svtk plot spatial cluster-feature-heatmap [-h] --input INPUT --output
                                              OUTPUT [--table TABLE]
                                              [--kwargs [KWARGS ...]]
                                              [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the feature_summary_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial cluster-solution-scores

Usage

svtk plot spatial cluster-solution-scores [-h] --input INPUT --output
                                              OUTPUT [--table TABLE]
                                              [--kwargs [KWARGS ...]]
                                              [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the score_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial correlogram

Usage

svtk plot spatial correlogram [-h] --input INPUT --output OUTPUT
                                  [--table TABLE] [--kwargs [KWARGS ...]]
                                  [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the distance_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial directional-correlogram

Usage

svtk plot spatial directional-correlogram [-h] --input INPUT --output
                                              OUTPUT [--table TABLE]
                                              [--kwargs [KWARGS ...]]
                                              [--kwargs-json KWARGS_JSON]
                                              [--fit FIT]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the directional_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

--fit

No

Value: fit. Convenience table path for the fit_df argument.

svtk plot spatial list

Usage

svtk plot spatial list [-h]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

svtk plot spatial path-bin-summary

Usage

svtk plot spatial path-bin-summary [-h] --input INPUT --output OUTPUT
                                       [--table TABLE]
                                       [--kwargs [KWARGS ...]]
                                       [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the path_summary_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial pattern-similarity

Usage

svtk plot spatial pattern-similarity [-h] --input INPUT --output OUTPUT
                                         [--table TABLE]
                                         [--kwargs [KWARGS ...]]
                                         [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the stations argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial pca-explained-variance

Usage

svtk plot spatial pca-explained-variance [-h] --input INPUT --output
                                             OUTPUT [--table TABLE]
                                             [--kwargs [KWARGS ...]]
                                             [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the explained_variance_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial pca-feature-loadings

Usage

svtk plot spatial pca-feature-loadings [-h] --input INPUT --output
                                           OUTPUT [--table TABLE]
                                           [--kwargs [KWARGS ...]]
                                           [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the feature_loadings_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial polar-residuals

Usage

svtk plot spatial polar-residuals [-h] --input INPUT --output OUTPUT
                                      [--table TABLE]
                                      [--kwargs [KWARGS ...]]
                                      [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial residual-correlation

Usage

svtk plot spatial residual-correlation [-h] --input INPUT --output
                                           OUTPUT [--table TABLE]
                                           [--kwargs [KWARGS ...]]
                                           [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the correlation_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.

svtk plot spatial semivariogram

Usage

svtk plot spatial semivariogram [-h] --input INPUT --output OUTPUT
                                    [--table TABLE] [--kwargs [KWARGS ...]]
                                    [--kwargs-json KWARGS_JSON]

Parameters

Name

Required

Default / choices

Description

-h, --help

No

show this help message and exit

--input

Yes

Value: input. Input CSV/parquet table for the distance_df argument.

--output

Yes

Value: output. Output figure path.

--table

No

Repeatable

Value: table. Extra table as argument_name=path. May be repeated.

--kwargs

No

Nargs: *

Value: kwargs. Extra function keyword arguments as key=value.

--kwargs-json

No

Value: kwargs_json. Extra function keyword arguments as a JSON/YAML mapping.