Changeset 78202b for doc/userguide/userguide.xml

Timestamp:

May 18, 2016, 10:02:06 PM (9 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

2fd88d1

Parents:

16d67a

git-author:

Frederik Heber <heber@…> (03/07/16 14:22:05)

git-committer:

Frederik Heber <heber@…> (05/18/16 22:02:06)

Message:

Adding potential action to parse and save atom fragment associations.

• Made KeySet serializable.
• added documentation on save and parse atom fragments.

File:

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

doc/userguide/userguide.xml

@@ -1713 +1713 @@
         <filename>homologies.dat</filename>.</para>
       </section>
+      <section xml:id="atomfragments">
+        <title xml:id="atomfragments.title">AtomFragments</title>
+        <para>Similarly, to <link linkend="homology">Homologies</link> also
+        the associations between atoms and the respective fragments they take
+        part in can be stored to a file and parse again at a later time.</para>
+       <programlisting>... --parse-atom-fragments atomfragments.dat</programlisting>
+        <para>This parses the all atom fragment associattions contained in the file
+        <filename>atomfragments.dat</filename> and <emphasis role="italic">appends</emphasis> 
+        them to the atom fragments associations container.</para>
+        <programlisting>... --save-atom-fragments atomfragments.dat</programlisting>
+        <para>Complementary, this stores the current contents of the atom fragments 
+        associations container, <emphasis role="italic">overwriting</emphasis> the file
+        <filename>atomfragments.dat</filename>.</para>
+      </section>
       <section xml:id="potentials">
         <title xml:id="potentials.title">Potentials</title>