[cig-commits] [commit] baagaard/feature-progress-monitor: Added documentation for progress monitors. (1a378b9)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/pylith

On branch  : baagaard/feature-progress-monitor
Link       : https://github.com/geodynamics/pylith/compare/6932460317df82082db62b5a460f18b080ce496e...1a378b94351c99f3953b8d78c638b29b984ee65c

>---------------------------------------------------------------

commit 1a378b94351c99f3953b8d78c638b29b984ee65c
Author: Brad Aagaard <baagaard at usgs.gov>
Date:   Mon Nov 3 09:20:34 2014 -0800

    Added documentation for progress monitors.


>---------------------------------------------------------------

1a378b94351c99f3953b8d78c638b29b984ee65c
 doc/userguide/runpylith/runpylith.lyx | 145 +++++++++++++++++++++++++++++++++-
 1 file changed, 144 insertions(+), 1 deletion(-)

diff --git a/doc/userguide/runpylith/runpylith.lyx b/doc/userguide/runpylith/runpylith.lyx
index 15730cc..4b43330 100644
--- a/doc/userguide/runpylith/runpylith.lyx
+++ b/doc/userguide/runpylith/runpylith.lyx
@@ -3392,6 +3392,10 @@ elastic_preset If true, perform a static calculation with elastic behavior
 formulation Formulation for solving the partial differential equation.
 \end_layout
 
+\begin_layout Description
+progress_monitor Simple progress monitor via text file.
+\end_layout
+
 \begin_layout Standard
 An example of setting the properties and components in a .cfg file is
 \end_layout
@@ -3405,6 +3409,10 @@ formulation = pylith.problems.Implicit ; default
 \end_layout
 
 \begin_layout LyX-Code
+progres_monitor = pylith.problems.ProgressMonitorTime ; default
+\end_layout
+
+\begin_layout LyX-Code
 elastic_preset = True ; default
 \end_layout
 
@@ -3931,13 +3939,21 @@ reference "sec:fault:cohesive:impulses"
 \family typewriter
 GreensFns
 \family default
- properties include:
+ properties amd facilities include:
 \end_layout
 
 \begin_layout Description
 fault_id Id of fault on which to impose slip impulses.
 \end_layout
 
+\begin_layout Description
+formulation Formulation for solving the partial differential equation.
+\end_layout
+
+\begin_layout Description
+progress_monitor Simple progress monitor via text file.
+\end_layout
+
 \begin_layout Standard
 An example of setting the properties for the GreensFns problem in a 
 \family typewriter
@@ -3966,6 +3982,18 @@ problem = pylith.problems.GreensFns ; Change problem type from the default
 fault_id = 100 ; Default value
 \end_layout
 
+\begin_layout LyX-Code
+formulation = pylith.problems.Implicit ; default
+\end_layout
+
+\begin_layout LyX-Code
+progres_monitor = pylith.problems.ProgressMonitorTime ; default
+\end_layout
+
+\begin_layout LyX-Code
+
+\end_layout
+
 \begin_layout Standard
 
 \series bold
@@ -3989,6 +4017,121 @@ FaultCohesiveImpulses
 \end_layout
 
 \begin_layout Section
+Progress Monitors
+\end_layout
+
+\begin_layout Quotation
+
+\family typewriter
+\color red
+New in v2.1.0.
+\end_layout
+
+\begin_layout Standard
+The progress monitors make it easy to monitor the general progress of long
+ simulations, especially on clusters where stdout is not always easily accessibl
+e.
+ The progress monitors update a simulation's current progress by writing
+ information to a text file.
+ The information includes time stamps, percent completed, and an estimate
+ of when the simulation will finish.
+ 
+\end_layout
+
+\begin_layout Subsection
+ProgressMonitorTime
+\end_layout
+
+\begin_layout Standard
+This is the default progress monitor for time-stepping problems.
+ The monitor calculates the percent completed based on the time at the current
+ time step and the total simulated time of the simulation, not the total
+ number of time steps (which may be unknown in simulations with adaptive
+ time stepping).
+ The 
+\family typewriter
+ProgressMonitorTime
+\family default
+ properties include:
+\end_layout
+
+\begin_layout Description
+update_percent Frequency (in percent) of progress updates.
+\end_layout
+
+\begin_layout Description
+filename Name of output file.
+\end_layout
+
+\begin_layout Description
+t_units Units for simulation time in output.
+\end_layout
+
+\begin_layout Standard
+An example of setting the properties in a .
+\family typewriter
+cfg
+\family default
+ file is:
+\end_layout
+
+\begin_layout LyX-Code
+[pylithapp.problem.progressmonitor]
+\end_layout
+
+\begin_layout LyX-Code
+update_percent = 5.0 ; default
+\end_layout
+
+\begin_layout LyX-Code
+filename = progress.txt ; default
+\end_layout
+
+\begin_layout LyX-Code
+t_units = year ; default
+\end_layout
+
+\begin_layout Subsection
+ProgressMonitorStep
+\end_layout
+
+\begin_layout Standard
+This is the default progress monitor for problems with a specified number
+ of steps, such as Green's function problems.
+ The monitor calculates the percent completed based on the number of steps
+ (e.g., Green's function impulses completed).
+ The ProgressMonitorStep propertiles include:
+\end_layout
+
+\begin_layout Description
+update_percent Frequency (in percent) of progress updates.
+\end_layout
+
+\begin_layout Description
+filename Name of output file.
+\end_layout
+
+\begin_layout Standard
+An example of setting the properties in a .
+\family typewriter
+cfg
+\family default
+ file is:
+\end_layout
+
+\begin_layout LyX-Code
+[pylithapp.problem.progressmonitor]
+\end_layout
+
+\begin_layout LyX-Code
+update_percent = 5.0 ; default
+\end_layout
+
+\begin_layout LyX-Code
+filename = progress.txt ; default
+\end_layout
+
+\begin_layout Section
 \begin_inset CommandInset label
 LatexCommand label
 name "sec:spatial:databases"