Changeset a10cc0 for JobMarket/src/documentation

Timestamp:

Jul 6, 2012, 10:18:46 AM (13 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, 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_BoundInBox_CenterInBox_MoleculeActions, 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, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, 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:

7da5cd

Parents:

7546b0

git-author:

Frederik Heber <heber@…> (05/18/12 14:37:17)

git-committer:

Frederik Heber <heber@…> (07/06/12 10:18:46)

Message:

Moved all Fragmentation/Automation into new subpackage JobMarket.

• adapted most files (which have been copied from sub-package LinearAlgebra).
• adapted all Makefile.ams to splitting.
• unit tests are ok.
• there is one very strange issue: Whereas for LinearAlgebra in its header files a prefix of "LinearAlgebra/" is _not_ required (and even has been removed when LinearAlgebra was placed in its own folder), the same does not hold for "JobMarket/". Here, we have to use both includes, one with the prefix and one without.
• NOTE: We force libJobMarket to be linked with c++ linker via dummy.cxx file.
• Removed all reference to FRAGMENT... in JobMarket's Makefile.am.

Location:

JobMarket/src/documentation

Files:

• Makefile.am (added)
• jobmarket.dox (moved) (moved from src/documentation/constructs/automation.dox ) (14 diffs)
• mainpage.dox (added)

JobMarket/src/documentation/jobmarket.dox ¶

@@ -7 +7 @@
 
 /**
- * \file automation.dox
+ * \file jobmarket.dox
  *
  * Created on: May 13, 2012
@@ -13 +13 @@
  */
 
-/** \page automation Automation
+/** \page jobmarket JobMarket
  *
  *  This page explains the (Fragmentation) Automation framework. The framework is
@@ -40 +40 @@
  *  In the following we explain these structures in more detail.
  *
- *  \section automation-serverclientcontroller Server, Client, and Controller
+ *  \section jobmarket-serverclientcontroller Server, Client, and Controller
  *
- *  \subsection automation-serverclientcontroller-server Server
+ *  \subsection jobmarket-serverclientcontroller-server Server
  *
  *  The main workload of the server is implemented in the \ref FragmentScheduler.
@@ -53 +53 @@
  *  clients or have been received from once busy clients.
  *
- *  \subsection automation-serverclientcontroller-client Client
+ *  \subsection jobmarket-serverclientcontroller-client Client
  *
  *  Clients are mainly implemented in \ref PoolWorker. They connect to a server
@@ -65 +65 @@
  *  back to the server.
  *
- *  \subsection automation-serverclientcontroller-controller Controller
+ *  \subsection jobmarket-serverclientcontroller-controller Controller
  *
  *  The Controller is an external program that connects to the server via
@@ -79 +79 @@
  *  -# shutdown: server should shutdown if pool is empty.
  *
- *  \subsection automation-serverclientcontroller-operations Operation
+ *  \subsection jobmarket-serverclientcontroller-operations Operation
  *
  *  An \ref Operation is implemented as a functor, i.e. all internally
@@ -108 +108 @@
  *  Only the \ref WorkerAddress to connect to is given in AsyncOperation::operator().
  *
- *  \subsection automation-serverclientcontroller-operationqueue Operations queue
+ *  \subsection jobmarket-serverclientcontroller-operationqueue Operations queue
  *
  *  As operations are usually asynchronous ones, they should not keep the
@@ -116 +116 @@
  *  Both server and client have such a \ref OperationQueue.
  *
- *  \subsection automation-serverclientcontroller-listener Listener
+ *  \subsection jobmarket-serverclientcontroller-listener Listener
  *
  *  The \ref Listener is a very important component for specifically both the
@@ -124 +124 @@
  *  incoming requests can be handled.
  *
- *  \subsubsection automation-serverclientcontroller-listener-pool Pool listener
+ *  \subsubsection jobmarket-serverclientcontroller-listener-pool Pool listener
  *
  *  The pool listener is the \ref Listener component of the client that listens
  *  for incoming connections from the server that sends it jobs.
  *
- *  \subsubsection automation-serverclientcontroller-listener-worker Worker listener
+ *  \subsubsection jobmarket-serverclientcontroller-listener-worker Worker listener
  *
  *  The \ref FragmentScheduler has two \ref Listener components, one listens for
@@ -137 +137 @@
  *  Only afterwards may the client send a valid command.
  *
- *  \subsubsection automation-serverclientcontroller-listener-controller Controller listener
+ *  \subsubsection jobmarket-serverclientcontroller-listener-controller Controller listener
  *
  *  The second \ref Listener component of the \ref FragmentScheduler listens to
@@ -145 +145 @@
  *  jobs.
  *
- *  \section automation-jobsresults Jobs and Results
+ *  \section jobmarket-jobsresults Jobs and Results
  *
  *  \ref FragmentJob and \ref FragmentResult are the internal core of the
- *  automation framework that handed around via boost::serialization
+ *  jobmarket framework that handed around via boost::serialization
  *  mechanism between controller, client, and server. Each job is uniquely
  *  identified by a unique \ref JobId. This pool of job ids is managed by the
@@ -158 +158 @@
  *  case of our \ref Fragmentation jobs)
  *
- *  \subsection automation-jobsresults-jobs Jobs
+ *  \subsection jobmarket-jobsresults-jobs Jobs
  *
  *  A \ref FragmentJob has a unique \ref JobId and a specific Work() operation
@@ -168 +168 @@
  *  and to place it in serialized form into the \ref FragmentResult's string.
  *
- *  \subsection automation-jobsresults-results Results
+ *  \subsection jobmarket-jobsresults-results Results
  *
  *  A \ref FragmentResult has a unique \ref JobId that has to match a before
@@ -175 +175 @@
  *  stores the exit code of e.g. a \ref SystemCommandJob.
  *
- * \date 2012-05-13
+ * \date 2012-05-18
  *
  */