From b5cca2389021a1e51a237e64ed283b5ec295fb1b Mon Sep 17 00:00:00 2001
From: dave <dave@dtu.dk>
Date: Tue, 1 Nov 2016 14:08:53 +0100
Subject: [PATCH] prepost.Simulations: updated doc strings
---
wetb/prepost/Simulations.py | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/wetb/prepost/Simulations.py b/wetb/prepost/Simulations.py
index 88f2ce22..b2ccffdf 100755
--- a/wetb/prepost/Simulations.py
+++ b/wetb/prepost/Simulations.py
@@ -1058,6 +1058,19 @@ def post_launch(cases, save_iter=False, silent=False, suffix=None,
----------
cases : either a string (path to file) or the cases itself
+
+ save_iter : boolean, default=False
+ Set to True to save the number of iterations per time step in
+ *.iter file (in the same folder as the logfile)
+
+ path_errorlog : str, default=None
+ Root path of the error logfiles. If set to None (default), the
+ value set in the [run_dir] tag is used as the root folder of the
+ logfiles.
+
+ suffix : str, default=None
+ If not None, the suffix will be appended to file name of the error
+ log analysis file as follows: "ErrorLog_suffix.csv".
"""
# TODO: finish support for default location of the cases and file name
@@ -3570,6 +3583,27 @@ class Cases(object):
check the logs files and make sure result files are present and
accounted for.
+
+ Parameters
+ ----------
+
+ save_iter : boolean, default=False
+ Set to True to save the number of iterations per time step in
+ *.iter file (in the same folder as the logfile)
+
+ pbs_failed_path : str, default=False
+ If not False, specify the path to which the *.p files of the
+ failed cases should be copied to. For example, the dlctemplate
+ will set this value to "pbs_in_fail".
+
+ path_errorlog : str, default=None
+ Root path of the error logfiles. If set to None (default), the
+ value set in the [run_dir] tag is used as the root folder of the
+ logfiles.
+
+ suffix : str, default=None
+ If not None, the suffix will be appended to file name of the error
+ log analysis file as follows: "ErrorLog_suffix.csv".
"""
# TODO: integrate global post_launch in here
self.cases_fail = post_launch(self.cases, save_iter=save_iter,
--
GitLab