[cig-commits] r17115 - short/3D/PyLith/trunk/doc/developer

[brad at geodynamics.org]

Author: brad
Date: 2010-08-24 09:06:26 -0700 (Tue, 24 Aug 2010)
New Revision: 17115

Added:
   short/3D/PyLith/trunk/doc/developer/toplevel_flow.txt
Modified:
   short/3D/PyLith/trunk/doc/developer/general
   short/3D/PyLith/trunk/doc/developer/howto_mergefromstable.txt
Log:
Added some more comments.

Modified: short/3D/PyLith/trunk/doc/developer/general
===================================================================
--- short/3D/PyLith/trunk/doc/developer/general	2010-08-24 00:00:52 UTC (rev 17114)
+++ short/3D/PyLith/trunk/doc/developer/general	2010-08-24 16:06:26 UTC (rev 17115)
@@ -9,7 +9,11 @@
 
 3. Files checked in to the repository trunk should at least compile.
 
-4. C++ and Python classes should have corresponding unit tests in
+4. Changes to the code that fix bugs in released code should be done
+in the stable branch. Those changes are then merged into the trunk
+(this is tricky, so please notify Brad and he will do it for you).
+
+5. C++ and Python classes should have corresponding unit tests in
 libtests and pytests. High-level functionality should be verified
 using a full-scale test.
 

Modified: short/3D/PyLith/trunk/doc/developer/howto_mergefromstable.txt
===================================================================
--- short/3D/PyLith/trunk/doc/developer/howto_mergefromstable.txt	2010-08-24 00:00:52 UTC (rev 17114)
+++ short/3D/PyLith/trunk/doc/developer/howto_mergefromstable.txt	2010-08-24 16:06:26 UTC (rev 17115)
@@ -1,3 +1,8 @@
+# THIS IS TRICKY and can cause hundreds of conflicts in your local 
+# version of the repository.
+#
+# Don't attempt a merge unless you really know what you are doing!!!!
+
 # Run svn log to find last marge.
 svn log | less
 

Added: short/3D/PyLith/trunk/doc/developer/toplevel_flow.txt
===================================================================
--- short/3D/PyLith/trunk/doc/developer/toplevel_flow.txt	                        (rev 0)
+++ short/3D/PyLith/trunk/doc/developer/toplevel_flow.txt	2010-08-24 16:06:26 UTC (rev 17115)
@@ -0,0 +1,14 @@
+Top-Level Flow of PyLith
+
+pylith "main"
+
+  The pylith Python script creates a PyLithApp object, which controls
+  the flow of the code.
+
+problem
+
+  The type of PyLith simulation is known as a "problem". Currently,
+  only time-dependent problems are solved. The TimeDependent.run()
+  method controls the time-stepping with quasi-static time-stepping
+  handled by the Implicit object and the dynamic time-stepping handled
+  by the Explicit object.