1212def expected_hotstarts (run_start , dt , nday , hot_freq ):
1313 """
1414 Generate expected hotstarts based on run parameters.
15+
1516 Parameters
1617 ----------
1718 run_start : datetime
@@ -22,18 +23,19 @@ def expected_hotstarts(run_start, dt, nday, hot_freq):
2223 The number of days for the simulation run.
2324 hot_freq : pandas.tseries.offsets.DateOffset
2425 The frequency at which hotstarts are generated.
26+
2527 Returns
2628 -------
2729 pandas.DataFrame
2830 A DataFrame with a DatetimeIndex representing the expected hotstart times
2931 and a column "iteration" indicating the corresponding iteration numbers.
32+
3033 Notes
3134 -----
3235 This function calculates the expected hotstart times and their corresponding
3336 iteration numbers based on the provided simulation parameters. It does not
3437 perform any file inventory or check for existing hotstart files.
3538 """
36- """Generate expected hotstarts based on run parameters."""
3739
3840 end = run_start + days (nday )
3941 t = run_start
@@ -151,6 +153,7 @@ def hotstart_inventory_exist(start, dt=90, workdir=".", do_print=True):
151153 """
152154 Check for the existence of hotstart inventory files and generate a DataFrame
153155 mapping iterations to corresponding datetime values.
156+
154157 Parameters
155158 ----------
156159 start : str or pandas.Timestamp
@@ -161,10 +164,12 @@ def hotstart_inventory_exist(start, dt=90, workdir=".", do_print=True):
161164 Directory to search for hotstart files (default is '.').
162165 do_print : bool, optional
163166 Whether to print the iterations and corresponding times (default is True).
167+
164168 Returns
165169 -------
166170 pandas.DataFrame
167171 A DataFrame with datetime as the index and iteration numbers as the column.
172+
168173 Notes
169174 -----
170175 - The function searches for hotstart files in the specified `workdir` directory.
0 commit comments