svtk map

Command Tree

svtk map
- svtk map spatial
  
  svtk map spatial block-holdout-error
  
  svtk map spatial cluster
  
  svtk map spatial corridor
  
  svtk map spatial event-residual
  
  svtk map spatial list
  
  svtk map spatial metric-by-model
  
  svtk map spatial model-improvement
  
  svtk map spatial pca-mode
  
  svtk map spatial redcap-cluster
  
  svtk map spatial residual-grid
  
  svtk map spatial score
  
  svtk map spatial station-bias
  
  svtk map spatial station-metric

Command Details

Usage

svtk map [-h] {spatial} ...

Parameters

Name	Required	Default / choices	Description
`-h`, `--help`	No		show this help message and exit

svtk map spatial

Usage

svtk map spatial [-h]
                     {list,block-holdout-error,cluster,corridor,event-residual,metric-by-model,model-improvement,pca-mode,redcap-cluster,residual-grid,score,station-bias,station-metric}
                     ...

Parameters

Name	Required	Default / choices	Description
`-h`, `--help`	No		show this help message and exit

svtk map spatial block-holdout-error

Usage

svtk map spatial block-holdout-error [-h] --input INPUT --output OUTPUT
                                         [--table TABLE]
                                         [--kwargs [KWARGS ...]]
                                         [--kwargs-json KWARGS_JSON]
                                         [--config CONFIG]
                                         [--run-scenario RUN_SCENARIO]
                                         [--bounds BOUNDS] [--no-basemap]
                                         [--basemap-source BASEMAP_SOURCE]

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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial cluster

Usage

svtk map spatial cluster [-h] --input INPUT --output OUTPUT
                             [--table TABLE] [--kwargs [KWARGS ...]]
                             [--kwargs-json KWARGS_JSON] [--config CONFIG]
                             [--run-scenario RUN_SCENARIO]
                             [--bounds BOUNDS] [--no-basemap]
                             [--basemap-source BASEMAP_SOURCE]

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 assignments_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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial corridor

Usage

svtk map spatial corridor [-h] --input INPUT --output OUTPUT
                              [--table TABLE] [--kwargs [KWARGS ...]]
                              [--kwargs-json KWARGS_JSON] [--events EVENTS]
                              [--records RECORDS] [--stations STATIONS]
                              [--config CONFIG]
                              [--run-scenario RUN_SCENARIO]
                              [--bounds BOUNDS] [--no-basemap]
                              [--basemap-source BASEMAP_SOURCE]

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 corridors_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.
`--events`	No		Value: `events`. Convenience table path for the events_df argument.
`--records`	No		Value: `records`. Convenience table path for the records_df argument.
`--stations`	No		Value: `stations`. Convenience table path for the stations_df argument.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial event-residual

Usage

svtk map spatial event-residual [-h] --input INPUT --output OUTPUT
                                    [--table TABLE] [--kwargs [KWARGS ...]]
                                    [--kwargs-json KWARGS_JSON]
                                    [--config CONFIG]
                                    [--run-scenario RUN_SCENARIO]
                                    [--bounds BOUNDS] [--no-basemap]
                                    [--basemap-source BASEMAP_SOURCE]

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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial list

Usage

svtk map spatial list [-h]

Parameters

Name	Required	Default / choices	Description
`-h`, `--help`	No		show this help message and exit

svtk map spatial metric-by-model

Usage

svtk map spatial metric-by-model [-h] --input INPUT --output OUTPUT
                                     [--table TABLE]
                                     [--kwargs [KWARGS ...]]
                                     [--kwargs-json KWARGS_JSON]
                                     [--config CONFIG]
                                     [--run-scenario RUN_SCENARIO]
                                     [--bounds BOUNDS] [--no-basemap]
                                     [--basemap-source BASEMAP_SOURCE]

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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial model-improvement

Usage

svtk map spatial model-improvement [-h] --input INPUT --output OUTPUT
                                       [--table TABLE]
                                       [--kwargs [KWARGS ...]]
                                       [--kwargs-json KWARGS_JSON]
                                       [--config CONFIG]
                                       [--run-scenario RUN_SCENARIO]
                                       [--bounds BOUNDS] [--no-basemap]
                                       [--basemap-source BASEMAP_SOURCE]

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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial pca-mode

Usage

svtk map spatial pca-mode [-h] --input INPUT --output OUTPUT
                              [--table TABLE] [--kwargs [KWARGS ...]]
                              [--kwargs-json KWARGS_JSON] [--config CONFIG]
                              [--run-scenario RUN_SCENARIO]
                              [--bounds BOUNDS] [--no-basemap]
                              [--basemap-source BASEMAP_SOURCE]

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 station_scores_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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial redcap-cluster

Usage

svtk map spatial redcap-cluster [-h] --input INPUT --output OUTPUT
                                    [--table TABLE] [--kwargs [KWARGS ...]]
                                    [--kwargs-json KWARGS_JSON]
                                    [--config CONFIG]
                                    [--run-scenario RUN_SCENARIO]
                                    [--bounds BOUNDS] [--no-basemap]
                                    [--basemap-source BASEMAP_SOURCE]

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 redcap_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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial residual-grid

Usage

svtk map spatial residual-grid [-h] --input INPUT --output OUTPUT
                                   [--table TABLE] [--kwargs [KWARGS ...]]
                                   [--kwargs-json KWARGS_JSON]
                                   [--config CONFIG]
                                   [--run-scenario RUN_SCENARIO]
                                   [--bounds BOUNDS] [--no-basemap]
                                   [--basemap-source BASEMAP_SOURCE]

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 grid_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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial score

Usage

svtk map spatial score [-h] --input INPUT --output OUTPUT
                           [--table TABLE] [--kwargs [KWARGS ...]]
                           [--kwargs-json KWARGS_JSON] [--config CONFIG]
                           [--run-scenario RUN_SCENARIO] [--bounds BOUNDS]
                           [--no-basemap] [--basemap-source BASEMAP_SOURCE]

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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial station-bias

Usage

svtk map spatial station-bias [-h] --input INPUT --output OUTPUT
                                  [--table TABLE] [--kwargs [KWARGS ...]]
                                  [--kwargs-json KWARGS_JSON]
                                  [--config CONFIG]
                                  [--run-scenario RUN_SCENARIO]
                                  [--bounds BOUNDS] [--no-basemap]
                                  [--basemap-source BASEMAP_SOURCE]

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 station_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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.

svtk map spatial station-metric

Usage

svtk map spatial station-metric [-h] --input INPUT --output OUTPUT
                                    [--table TABLE] [--kwargs [KWARGS ...]]
                                    [--kwargs-json KWARGS_JSON]
                                    [--config CONFIG]
                                    [--run-scenario RUN_SCENARIO]
                                    [--bounds BOUNDS] [--no-basemap]
                                    [--basemap-source BASEMAP_SOURCE]

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.
`--config`	No		Value: `config`. Optional Spatial-VTK config for named bounds.
`--run-scenario`	No		Value: `run_scenario`. Apply one named run_scenarios overlay.
`--bounds`	No		Value: `bounds`. Named bounds from config or comma-separated lon_min,lon_max,lat_min,lat_max.
`--no-basemap`	No	Flag	Disable basemap rendering for map figures.
`--basemap-source`	No		Value: `basemap_source`. Optional contextily basemap source.