Changeset 101d2d for doc

Timestamp:

Jun 21, 2017, 9:52:01 PM (8 years ago)

Author:

Frederik Heber <frederik.heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_SelectAtomByNameAction, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_StructOpt_integration_tests, AutomationFragmentation_failures, Candidate_v1.6.1, ChangeBugEmailaddress, ChemicalSpaceEvaluator, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph_documentation, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, Fix_Verbose_Codepatterns, ForceAnnealing_oldresults, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, Gui_displays_atomic_force_velocity, IndependentFragmentGrids_IntegrationTest, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, StoppableMakroAction, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps

Children:

78ea3c

Parents:

7294dc

git-author:

Frederik Heber <heber@…> (03/23/17 17:11:07)

git-committer:

Frederik Heber <frederik.heber@…> (06/21/17 21:52:01)

Message:

DOCU: Added note on necessity of wait() to Python section.

File:

• doc/userguide/userguide.xml (modified) (1 diff)

doc/userguide/userguide.xml

@@ -2518 +2518 @@
       under the command-line interface and look up the function name via
       help.</para>
+      <para>You can freely mix calls to the pymolecuilder module and other python commands.</para>
+      <note>However, be aware that all Actions are executed in another thread,
+      i.e. run in parallel. That means that a pymolecuilder command is not 
+      necessarily finished when python steps on to the next line!</note>
+      <para>In order to make python wait for the Actions to finish before
+      stepping, there is the special wait() command.</para>
+      <programlisting>
+         mol.MoleculeLoad("...")
+         mol.wait()
+      </programlisting>
+      <para>This will continue first after the molecule has been fully loaded.
+      </para>
+      <warning>These wait()s will have no effect if the python script is loaded
+      via the "load-session" command inside a User Interface (command-line,
+      GUI, ...) as this would cause the queue to wait indefinitely, namely till
+      the load-session itself would have finished.</warning>
+      <para>Therefore, more complex python scripts need to be called with
+      python and a set PYTHONPATH as described above.</para>
     </section>
   </chapter>