|
Last change
on this file since 0f3042 was 750cff, checked in by Frederik Heber <heber@…>, 14 years ago |
|
HUGE: Update on documenation.
- a general skeleton of the documentation is now in place with all the major
components of MoleCuilder explained to some extent.
- some information has been transfered from TRAC (e.g. install procecure) into
this doxygen documentation where it is general and not specific to the
situation at our institute.
|
-
Property mode
set to
100644
|
|
File size:
1.1 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 | *
|
|---|
| 27 | * The programs can be executed by running:
|
|---|
| 28 | * - Text menu: Launching molecuilder with no options always gives the text menu.
|
|---|
| 29 | * \code ./molecuilder \endcode
|
|---|
| 30 | * - Command line menu: Depends on what you want, but an exemplary call is
|
|---|
| 31 | * \code ./molecuilder -i test.xyz -o tremolo xyz -v 3 --add-atom H --position "0,0,0"\endcode
|
|---|
| 32 | * - Graphical menu
|
|---|
| 33 | * \code ./molecuildergui \endcode
|
|---|
| 34 | *
|
|---|
| 35 | * The user interface are explained in greater detail in \ref userinterfaces.
|
|---|
| 36 | *
|
|---|
| 37 | *
|
|---|
| 38 | * \date 2011-10-31
|
|---|
| 39 | *
|
|---|
| 40 | */
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
