Skip to content

Commit 7c9df93

Browse files
committed
Update --help information for PyLithApp.
1 parent 8086f22 commit 7c9df93

File tree

2 files changed

+23
-8
lines changed

2 files changed

+23
-8
lines changed

pylith/apps/PyLithApp.py

+7-8
Original file line numberDiff line numberDiff line change
@@ -204,21 +204,20 @@ def showHelp(self):
204204
" Running pylithinfo --verbose [-o pylith_parameters.txt] [PyLith args]\n"
205205
" will dump all parameters with descriptions to pylith_parameters.txt.\n"
206206
"\n"
207-
"For quasi-static simulations, use the following solver settings to make sure the linear and nonlinear solvers are converging:\n"
208-
"[pylithapp.petsc]\n"
209-
"ksp_converged_reason = true\n"
210-
"ksp_error_if_not_converged = true\n"
211-
"snes_converged_reason = true\n"
212-
"snes_error_if_not_converged = true\n"
207+
"Add $PYLITH_DIR/share/settings/petsc_monitor.cfg to your command line arguments\n"
208+
"to turn on several PETSc monitors:"
209+
" pylith YOUR_FILE.cfg PATH_TO_PYITH_SHARE/share/settings/petsc_monitor.cfg\n"
213210
"\n"
214-
"If you still need help, send an email to [email protected] with the following info:\n"
211+
"If you still need help, visit the PyLith category on the CIG community forum:\n"
212+
"https://community.geodynamics.org.\n"
213+
"When submitting a question about running a simulation, be sure to include the info:\n"
215214
"\n"
216215
"1. Describe what you are trying to do\n"
217216
" a. Overview of the problem and boundary conditions (diagrams are very helpful)\n"
218217
" b. 2-D or 3-D\n"
219218
" c. Cell type (tri, quad, hex, or tet)\n"
220219
" d. Type of fault: prescribed slip or spontaneous rupture\n"
221-
"2. Include the output of running 'pylith --version'\n"
220+
"2. Attach the PyLith parameters .json file\n"
222221
"3. Send the *entire* error message, not just what you think is important (entire log is best).\n"
223222
"\n"
224223
"Description and help for PyLithApp component:\n"

share/settings/petsc_monitor.cfg

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[pylithapp.petsc]
2+
# Turn on TS, KSP, and SNES monitors
3+
ts_monitor = true
4+
ksp_monitor = true
5+
ksp_converged_reason = true
6+
snes_monitor = true
7+
snes_linsearch_monitor = true
8+
snes_converged_reason = true
9+
10+
# Turn on KSP and SNES view
11+
ksp_view = true
12+
snes_view = true
13+
14+
# Trigger error if linear or nonlinear solvers fail to converge
15+
ksp_error_if_not_converged = true
16+
snes_error_if_not_converged = true

0 commit comments

Comments
 (0)