diff --git a/dartwrf/assim_synth_obs.py b/dartwrf/assim_synth_obs.py index 7e5b40f9232e413d3b38266f485996a7b0b6f67c..54089e3d5719aee4be145ea91b87ac30ed44365b 100755 --- a/dartwrf/assim_synth_obs.py +++ b/dartwrf/assim_synth_obs.py @@ -283,7 +283,18 @@ def qc_obs(time, oso, osf_prior): def evaluate(assim_time, output_format="%Y-%m-%d_%H:%M_obs_seq.final-eval_posterior_allobs"): - """Depending on input_list.txt, this function calculates either prior or posterior obs space values. + """Calculates either prior or posterior obs space values. + + Note: Depends on a prepared input_list.txt, which defines the ensemble (prior or posterior). + + Output file: Saves obs_seq.final to `/archivedir/obs_seq_final/` + + Args: + assim_time (datetime): time of assimilation + output_format (str): format string for output filename, default is `"%Y-%m-%d_%H:%M_obs_seq.final-eval_posterior_allobs"` + + Returns: + obsseq.ObsSeq """ os.makedirs(cluster.dart_rundir, exist_ok=True) # create directory to run DART in