source: src/documentation/mainpage.dox@ 19bc74

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
Last change on this file since 19bc74 was 19bc74, checked in by Frederik Heber <heber@…>, 13 years ago

Explained most of the tests.

  • Property mode set to 100644
File size: 1.8 KB
Line 
1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2010 University of Bonn. All rights reserved.
5 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
6 */
7
8/**
9 * \file mainpage.dox
10 *
11 * Here, the mainpage (index.html) for the doxygen documentation resides.
12 *
13 * Created on: Oct 11, 2011
14 * Author: heber
15 */
16
17/*! \page copyright Copyright notice
18 *
19 * MoleCuilder - to create and alter molecular systems
20 * Copyright (C) 2010 University Bonn. All rights reserved.
21 *
22 */
23
24/*! \mainpage MoleCuilder - a molecular set builder
25 *
26 * This introductory shall briefly make acquainted with the program, helping in installing and a first run.
27 *
28 * \section about About the Program
29 *
30 * MoleCuilder is a program, written entirely in C++, that enables the construction of a coordinate set for the
31 * atoms making up an molecule. It allows for both building of simple molecules by adding atom-wise giving bond
32 * angles and distances or absolute coordinates, but also using them as templates. Regions can be specified and
33 * ordered to be filled with a molecule in a certain manner. Greater conglomerations of molecules can be tesselated
34 * and recognized as a region themselves to be subsequently surrounded by other (surface solvated) molecules.
35 * In the end, MoleCuilder allows the construction of arbitrary nano structures, whether they be crystalline or
36 * amorphic in nature.
37 *
38 * For copyright see \subpage copyright.
39 *
40 * \section Contents
41 *
42 * This manual is divided into the following sections:
43 * \li \subpage install "Installation Instructions"
44 * \li \subpage test "Automated testing"
45 * \li \subpage launch "Launching the Code"
46 * \li \subpage code "How to the use and extend the code"
47 *
48 */
49
50
51
Note: See TracBrowser for help on using the repository browser.