Changeset 0a7834 for src/documentation/install.dox

Timestamp:

Feb 14, 2013, 12:25:52 PM (12 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:

6752dc

Parents:

d0faa8

git-author:

Frederik Heber <heber@…> (12/14/12 16:26:21)

git-committer:

Frederik Heber <heber@…> (02/14/13 12:25:52)

Message:

DOCU: Updates optional enable targets and required and optional packets on install page.

File:

• src/documentation/install.dox (modified) (4 diffs)

src/documentation/install.dox

@@ -35 +35 @@
  *
  * which will run the configure script that checks whether you have a current
- * version of the following required packages
+ * version of the following required packages:
  *
  * -# GNU Scientific Library (specify via LDFLAGS, ...)
@@ -43 +43 @@
  * -# CPPUnit framework (--with-cppunit-prefix=<dir>)
  * -# CodePatterns (--with-codepatterns=<dir>)
+ *
+ * The following packages are optional (code parts/features are disabled if not
+ * found:
+ * -# JobMarket (--enable-jobmarket --with-jobmarket=<dir>
+ * -# VMG library of ScaFaCoS (--enable-vmg --with-vmg-mpi MPICXX=mpicxx PKGCONFIG=<path to ScaFaCoS pkdir>)
+ * -# levmar (--with-levmar=<dir>)
  *
  * \a --prefix is the argument to tell configure where all program code should go
@@ -60 +66 @@
  * - \a --enable-debug - activates many internal asserts, memory debugger and more
  *  (makes code a lot slower but gives information in case something fails)
+ * - \a --enable-python - activates python scripting. For one you can control
+ *  molecuilder within your python code by simply calling its actions. For another
+ *  it automatically executes a script \b molecuilder.py in the current folder
+ *  prior to launching the respective UI.
+ *  - \a --disable-cache - disables caching of certain variables (see CodePatterns).
+ *  - \a --enable-valgrind - each test of the testsuite is launched by wrapping
+ *  the call through valgrind checking on correct handling of memory.
+ *  - \a --with-levmar=<path> - if levmar package is found under given path and
+ *  LAPACK is installed, then FunctionApproximation can be used to fit potentials.
  *
  * \note A note about configure: If one library is found only under some specific path, you
@@ -129 +144 @@
  *    binary directory
  *  -# make doc: Creates these html pages out of the documented source
- *  -# make check: Runs an extensive set of unit tests and a testsuite which also gives
- *    a good overview on the set of functions.
+ *  -# make distcheck: Checks whether the code compiles and all tests runs without
+ *  from a distributed archive. This is checked for each release version.
  *
- * \date 2011-10-31
+ * \date 2012-12-20
  */