Skip to content
Snippets Groups Projects
Installation.txt 1.54 KiB
Newer Older
/**

\page Installation Installation

At the present times plumed can be added to the following list of codes:

@CODES@

\section CompilingPlumed Compiling Plumed

Giovanni Bussi's avatar
Giovanni Bussi committed
First configure using
\verbatim
> ./configure
\endverbatim

In case it is necessary, edit the resulting Makefile.conf. A new file sourceme.sh
will appear in the main plumed directory. Just source it (presently only for bash shell):
\verbatim
> source sourceme.sh
\endverbatim

Then compile plumed
\verbatim
> make -j 4
\endverbatim
Giovanni Bussi's avatar
Giovanni Bussi committed
A "plumed" executable should be in your path. Try to type
\verbatim
> plumed -h
\endverbatim
Giovanni Bussi's avatar
Giovanni Bussi committed
You can also check if plumed is correctly compiled performing our regression tests.
Be warned that some of them just fails because of the different numerical accuracy of different machines.
\verbatim
> cd regtest
> make
\endverbatim 


\section Patching Patching your MD code

To patch your MD code, you should have PLUMED already installed and properly
working. In particular, you should have the command "plumed" in your execution
path. Then, follow these steps
- Configure and compile your MD enginge
- Test if it is working properly
- Go to the root diretory of the MD engine
- Patch:
\verbatim
Giovanni Bussi's avatar
Giovanni Bussi committed
> plumed patch -p
\endverbatim
The script will interactively ask which MD engine you are patching.
- Recompile the MD code (if dependencies are set up properly in the MD engine,
  only modified files will be recompiled)

If your MD code is not supported, you may want to implement an interface for
it. Refer to the <a href="../../developer-doc/html/index.html"> developer
manual </a>.


*/