source: src/documentation/launch.dox

Candidate_v1.6.1
Last change on this file was caece4, checked in by Frederik Heber <heber@…>, 11 years ago

Enhanced documentation significantly.

  • went through all of the constructs and updated each.
  • enhanced documentation ofr Fragmentation::FragmentMolecule().
  • Property mode set to 100644
File size: 1.4 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 launch.dox
10 *
11 * Created on: Oct 28, 2011
12 * Author: heber
13 */
14
15/**
16 * \page launch Running the code
17 *
18 * Before you have done
19 * \code
20 * make install
21 * \endcode
22 * The executables are in the \b src folder of your build directory. There are
23 * two variants:
24 * - molecuilder (contains command line and text interface)
25 * - molecuildergui (contains graphical user interface)
26 * There is one more variant, a python module, residing in the libs folder:
27 * - pyMoleCuilder
28 *
29 * The programs can be executed by running:
30 * - Text menu: Launching molecuilder with no options always gives the text menu.
31 * \code ./molecuilder \endcode
32 * - Command line menu: Depends on what you want, but an exemplary call is
33 * \code ./molecuilder -i test.xyz -o tremolo xyz -v 3 --add-atom H --position "0,0,0"\endcode
34 * - Graphical menu
35 * \code ./molecuildergui \endcode
36 * - Python interface
37 * \code PYTHONPATH="<installpath>/libs" /usr/bin/python \endcode
38 * Then try,
39 * \code
40 * import pyMoleCuilder as mol
41 * help(mol)
42 * \endcode
43 *
44 * The user interface are explained in greater detail in \ref userinterfaces.
45 *
46 *
47 * \date 2014-03-10
48 *
49 */
Note: See TracBrowser for help on using the repository browser.