mirror of
https://github.com/arcan1s/moldyn.git
synced 2025-07-15 06:45:50 +00:00
66 lines
1.6 KiB
Plaintext
66 lines
1.6 KiB
Plaintext
/*!
|
|
* @mainpage envir
|
|
* @image latex ./logo.png
|
|
*
|
|
* @section intro_sec Introduction
|
|
*
|
|
* <b>About this program</b>:
|
|
* <ul>
|
|
* <li>Program that searchs environment for chosen molecule by geometric criterion
|
|
* </ul>
|
|
*
|
|
* <b>Developer</b>:
|
|
* <ul>
|
|
* <li>Evgeniy Alekseev aka arcanis <pre><esalexeev (at) gmail (dot) com></pre>
|
|
*</ul>
|
|
* <b>License</b>:
|
|
* <ul>
|
|
* <li>GPL
|
|
* </ul>
|
|
*
|
|
* @section How-To-Use How to use
|
|
* Usage:
|
|
* <pre>
|
|
* envir -i FILENAME -c X,Y,Z -o FILEMANE [ -n NUM_OF_MOLECULE ] [ -r RADIUS ]
|
|
* [ -l LOGFILE] [ -q ] [ -h ]
|
|
*
|
|
* Parametrs:
|
|
* -i - input file with coordinates
|
|
* -c - cell size (float), A
|
|
* -o - output file with coordinates
|
|
* -n - number of molecule for search (integer). Default is 1
|
|
* -r - radius of environment (float). Default is 6.0
|
|
* -l - log enable
|
|
* -q - quiet enable
|
|
* -h - show this help and exit
|
|
* </pre>
|
|
*
|
|
* @page Install
|
|
*
|
|
* @section Requirements Requirements
|
|
* The application statgen requires the following external stuff:
|
|
* - cmake >= 2.8
|
|
* - gcc >= 4.8
|
|
*
|
|
* @section How-To How to install
|
|
*
|
|
* @subsection Linux Linux
|
|
* @code
|
|
* mkdir build && cd build
|
|
* cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../
|
|
* make
|
|
* make install
|
|
* @endcode
|
|
*
|
|
* @subsection Windows Windows
|
|
* @code
|
|
* create project file using 'cmake'
|
|
* compile project
|
|
* @endcode
|
|
* You may also download compiled executable file for Win_x86.
|
|
*
|
|
* @page Changelog
|
|
* V.1.0.1 (2013-07-27)
|
|
* * initial release
|
|
*/
|