.. _cli-svtk-map: svtk map ======== Command Tree ------------ - :ref:`svtk map ` - :ref:`svtk map spatial ` - :ref:`svtk map spatial block-holdout-error ` - :ref:`svtk map spatial cluster ` - :ref:`svtk map spatial corridor ` - :ref:`svtk map spatial event-residual ` - :ref:`svtk map spatial list ` - :ref:`svtk map spatial metric-by-model ` - :ref:`svtk map spatial model-improvement ` - :ref:`svtk map spatial pca-mode ` - :ref:`svtk map spatial redcap-cluster ` - :ref:`svtk map spatial residual-grid ` - :ref:`svtk map spatial score ` - :ref:`svtk map spatial station-bias ` - :ref:`svtk map spatial station-metric ` Command Details --------------- .. rubric:: Usage .. code-block:: bash svtk map [-h] {spatial} ... .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - Name - Required - Default / choices - Description * - ``-h``, ``--help`` - No - - show this help message and exit .. _cli-svtk-map-spatial: svtk map spatial ^^^^^^^^^^^^^^^^ .. rubric:: Usage .. code-block:: bash 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} ... .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - Name - Required - Default / choices - Description * - ``-h``, ``--help`` - No - - show this help message and exit .. _cli-svtk-map-spatial-block-holdout-error: svtk map spatial block-holdout-error """""""""""""""""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-cluster: svtk map spatial cluster """""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-corridor: svtk map spatial corridor """"""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-event-residual: svtk map spatial event-residual """"""""""""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-list: svtk map spatial list """"""""""""""""""""" .. rubric:: Usage .. code-block:: bash svtk map spatial list [-h] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - Name - Required - Default / choices - Description * - ``-h``, ``--help`` - No - - show this help message and exit .. _cli-svtk-map-spatial-metric-by-model: svtk map spatial metric-by-model """""""""""""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-model-improvement: svtk map spatial model-improvement """""""""""""""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-pca-mode: svtk map spatial pca-mode """"""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-redcap-cluster: svtk map spatial redcap-cluster """"""""""""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-residual-grid: svtk map spatial residual-grid """""""""""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-score: svtk map spatial score """""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-station-bias: svtk map spatial station-bias """"""""""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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. .. _cli-svtk-map-spatial-station-metric: svtk map spatial station-metric """"""""""""""""""""""""""""""" .. rubric:: Usage .. code-block:: bash 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] .. rubric:: Parameters .. list-table:: :header-rows: 1 :widths: 26 13 14 47 * - 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.