| 1 |
Once installed, this directory contains CMakelist.txt, |
| 2 |
Makefile.pkg and a small program that you could use as |
| 3 |
a template when writing your own analysis software. |
| 4 |
Further explanation for the template code can be found |
| 5 |
in the Doxygen documentation: |
| 6 |
<@DOCUMENTATION_HTTP_URL_BASE@/doxygen/html-user/page_analysistemplate.xhtml> |
| 7 |
|
| 8 |
The CMakelist.txt can be used together with cmake to |
| 9 |
build the template program: |
| 10 |
$ source /path/to/GMXRC |
| 11 |
$ cmake /path/to/template |
| 12 |
Alternatively, setting CMAKE_PREFIX_PATH will direct cmake |
| 13 |
to find a particular GROMACS installation. |
| 14 |
|
| 15 |
The Makefile.pkg can be used if cmake is unavailable. It |
| 16 |
makes use of pkg-config to build the template program: |
| 17 |
$ source /path/to/GMXRC |
| 18 |
$ make -f Makefile.pkg |
| 19 |
|
| 20 |
You will need to make sure that you use the same C++ compiler |
| 21 |
and C++ Standard Library as the one that was used for compiling |
| 22 |
GROMACS. |
| 23 |
See the Doxygen documentation for using GROMACS as a library for |
| 24 |
more details about the build system used to build the template, as |
| 25 |
well as its limitations: |
| 26 |
<@DOCUMENTATION_HTTP_URL_BASE@/doxygen/html-user/page_usinglibrary.xhtml> |
| 27 |
Note in particular that the CMake mechanism does not work if GROMACS |
| 28 |
was built with GMX_BUILD_OWN_FFTW=ON. |
| 29 |
|
| 30 |
---------------------------------------------------------- |
| 31 |
|
| 32 |
If you are reading this in the distribution directory, |
| 33 |
remember that CMakelist.txt.template will be renamed to |
| 34 |
CMakelist.txt during the installation. |