Skip to content

Commit 8b2eff7

Browse files
fix hot_nudge_data documentation
1 parent 427aaba commit 8b2eff7

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

bdschism/bdschism/hotstart_nudging_data.py

+4-6
Original file line numberDiff line numberDiff line change
@@ -267,12 +267,10 @@ def hotstart_nudge_data(sdate, ndays, dest, repo_dir):
267267

268268

269269
@click.command(
270-
help="""
271-
Download station data from repo and save in csv format for hotstart
272-
nudging.
273-
Usage:
274-
hotstart_nudging_data --start_date 2018-02-19 --nudge_len 300
275-
--dest_dir . --repo_dir $repo_path
270+
help="""\n
271+
Download station data from repo and save in csv format for hotstart nudging.\n
272+
Usage:\n
273+
bds hot_nudge_data --start_date 2018-02-19 --nudge_len 300 --dest_dir . --repo_dir $repo_path\n
276274
"""
277275
)
278276
@click.option(

docsrc/topics/nudging.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Preparing for nudging with observation data
8181
For nudging using observtion data, one must prepare the time series inputs using `hotstart_nudging_data from BayDeltaSCHISM <https://github.com/CADWRDeltaModeling/BayDeltaSCHISM/blob/master/bdschism/bdschism/hotstart_nudging_data.py>`_.
8282

8383
The start date, length of nudging, and the location of the time series files need to be specified in the following manner:
84-
`python hotstart_nudging_data.py --start_date 2021-01-01 --nudge_len 10 --repo_dir $repo`, where `$repo` is the path to raw observation data.
84+
`bds hot_nudge_data --start_date 2021-01-01 --nudge_len 10 --repo_dir $repo`, where `$repo` is the path to raw observation data.
8585

8686
The recommended spin-up period using observation data is 10-15 days.
8787

@@ -97,7 +97,7 @@ Below is an example of nudging a Bay-Delta simulation spanning from 2021-01-01 t
9797

9898
.. code-block:: console
9999
100-
python bds hot_nudge_data --start_date 2021-01-01 --nudge_len 10 --dest_dir . --repo_dir "/scratch/nasbdo/modeling_data/repo/continuous/screened/"
100+
bds hot_nudge_data --start_date 2021-01-01 --nudge_len 10 --dest_dir . --repo_dir "/scratch/nasbdo/modeling_data/repo/continuous/screened/"
101101
102102
Here, the command is specifying that the start date of the simulation is 2021-01-01, and that the observed data will be used for nudging length of 10 days. The destination directory is the current working directory ("."), and the location of observed data can be found in the path following "--repo_dir".
103103

0 commit comments

Comments
 (0)