Difference between revisions of "Installation instructions"

From AutoMeKin
Jump to navigation Jump to search
(41 intermediate revisions by the same user not shown)
Line 1: Line 1:
==1. Obtaining the source code==
+
==Untar/unzip the tar.gz==
You can get a copy of the source code downloading  [http://forge.cesga.es/frs/?group_id=77&release_id=21 tsscds-SOURCE-2018rev1.tar.gz]. In this case you have to untar and unzip the file:
+
Once you have downloaded the source code, untar and unzip the file:
  
<code>tar xvfz tsscds-SOURCE-2018rev1.tar.gz</code>
+
<code>tar xvfz Amk-SOURCE-2018rev.tar.gz</code>
  
Alternatively you can create a local copy of the repository:
+
or clone the code from github:
  
<code>svn checkout --username anonsvn http://cvs.forge.cesga.es/svn/tsscds/tags/2018 tsscds </code>
+
<code>git clone <nowiki>https://github.com/emartineznunez/AutoMeKin.git</nowiki></code>
  
The password is 'anonsvn'.
+
==Installing dependencies==
The local copy is stored in tsscds folder. Before installing the package, go there (<code>cd tsscds</code>) and run:
+
Before installing amk for the first time, be aware that the following packages are needed:
  
<code>autoreconf --install</code>
+
''bc'', ''environment-modules'', ''gawk'', ''gcc'', ''gnuplot'', ''gfortran'', ''parallel'', ''python-numpy'', ''python-scipy'', ''sqlite3'', ''zenity''
  
to prepare and create some missing scripts (e.g. configure) in the package source.
+
You can install the missing ones manually, or you can use the scripts located in amk-SOURCE-2018 and called ''install-required-packages-distro.sh'' (where distro=ubuntu-16.4lts, centos7 or sl7), which will do the work for you.The ubuntu-16.4lts script installs all dependencies, but for the RHEL derivatives (centos7 and sl7) you have to install parallel separately, and you have two choices:
The checkout has to be done only once. Then, everytime you run the command:
 
  
<code>svn update </code>
+
a) ''install-gnu-parallel-from-source.sh''. This script installs parallel latest version from source thanks to Ole Tange (the author). Also it can fallback to a user private installation into $HOME/bin if you have not administrator permisions to install it globally.
  
the local copy will be updated to the latest revision.
+
b) ''install-gnu-parallel-from-epel.sh''. Enables the EPEL repository and installs parallel from it.
In any of the two cases (download or checkout) you have to install the dependencies (2) and install tsscds (3).
 
  
==2. Installing dependencies==
+
The program runs using two levels of theory: semiempirical (or Low-Level LL) and ab initio/DFT (or High-Level HL). So far, the only program interfaced with amk to perform the ab initio/DFT calculations is G09. Therefore, if you want to perform the HL calculations G09 should be installed and should run like in this example: g09<inputfile>outputfile.
Before installing tsscds for the first time, be aware that the following packages are needed:
 
  
''bc'', ''environment-modules'', ''gawk'', ''gcc'', ''gfortran'', ''parallel'', ''python-numpy'', ''python-scipy'', ''sqlite3'', ''zenity''
+
These packages might also be useful to analyze the results:
  
You can install the missing ones manually, or you can use the scripts located in tsscds-SOURCE-2018 (or tsscds if you employed checkout) and called ''install-required-packages-distro.sh'' (where distro=ubuntu-16.4lts, centos7 or sl7), which will do the work for you.The ubuntu-16.4lts script installs all dependencies, but for the RHEL derivatives (centos7 and sl7) you have to install parallel separately, and you have two choices:
+
''molden'', ''sqlitebrowser''
  
a) ''install-gnu-parallel-from-source.sh''. This script installs parallel latest version from source thanks to Ole Tange (the author). Also it can fallback to a user private installation into $HOME/bin if you have not administrator permisions to install it globally.
+
==Installation==
 +
Once the above packages are installed, either:
  
b) ''install-gnu-parallel-from-epel.sh''. Enables the EPEL repository and installs parallel from it.
+
Go to AutoMeKin if you cloned it from github
  
The program runs using two levels of theory: semiempirical (or Low-Level LL) and ab initio/DFT (or High-Level HL). So far, the only program interfaced with tsscds to perform the ab initio/DFT calculations is G09. Therefore, if you want to perform the HL calculations G09 should be installed and should run like in this example: g09<inputfile>outputfile.
+
<code>cd AutoMeKin</code>
  
These packages might also be useful to analyze the results:
+
or go to the amk-SOURCE-2018 folder, if you downloaded the tarball.
  
''gnuplot'', ''molden'', ''sqlitebrowser''
+
<code>cd amk-SOURCE-2018</code>
  
==3. Installation==
+
In both cases, the process continues the same way. Now type:
Once the above packages are installed, go to the tsscds-SOURCE-2018 folder (or tsscds if you employed checkout) to configure and install the package:
 
  
 
<code>./configure</code>
 
<code>./configure</code>
  
This will install tsscds2018 in $HOME/tsscds-2018 by default. If you want to install it in a different directory, type:
+
This will install amk in $HOME/amk-2018 by default. If you want to install it in a different directory, type:
  
 
<code>./configure --prefix=path_to_program</code>
 
<code>./configure --prefix=path_to_program</code>
Line 59: Line 56:
 
''module use path_to_program/modules''
 
''module use path_to_program/modules''
  
where ''path_to_program'' is the path where you installed tsscds (e.g., ''$HOME/tsscds-2018'').
+
where ''path_to_program'' is the path where you installed amk (e.g., ''$HOME/amk-2018'').
 +
 
 +
==Running the test==
 +
 
 +
To run the formic acid test example (explained in the [[Media:amk_tutorial.pdf| tutorial ]]) for a few trajectories follow these steps:
 +
 
 +
1) Load the module:
 +
 
 +
<code>module load amk/2018</code>
 +
 
 +
2) Run the script if amk has been installed in $HOME:
 +
 
 +
<code>run_test.sh</code>
 +
 
 +
or
 +
 
 +
<code>run_test.sh --prefix=path_to_program</code>
 +
 
 +
otherwise.
 +
 
 +
This will create a directory named FA_test, where you can check the results (see the [[Media:amk_tutorial.pdf| tutorial ]] for details). The test may take a few minutes.
  
  
[[Main Page]]
+
Return to [[AutoMeKin]]

Revision as of 18:18, 17 July 2019

Untar/unzip the tar.gz

Once you have downloaded the source code, untar and unzip the file:

tar xvfz Amk-SOURCE-2018rev.tar.gz

or clone the code from github:

git clone https://github.com/emartineznunez/AutoMeKin.git

Installing dependencies

Before installing amk for the first time, be aware that the following packages are needed:

bc, environment-modules, gawk, gcc, gnuplot, gfortran, parallel, python-numpy, python-scipy, sqlite3, zenity

You can install the missing ones manually, or you can use the scripts located in amk-SOURCE-2018 and called install-required-packages-distro.sh (where distro=ubuntu-16.4lts, centos7 or sl7), which will do the work for you.The ubuntu-16.4lts script installs all dependencies, but for the RHEL derivatives (centos7 and sl7) you have to install parallel separately, and you have two choices:

a) install-gnu-parallel-from-source.sh. This script installs parallel latest version from source thanks to Ole Tange (the author). Also it can fallback to a user private installation into $HOME/bin if you have not administrator permisions to install it globally.

b) install-gnu-parallel-from-epel.sh. Enables the EPEL repository and installs parallel from it.

The program runs using two levels of theory: semiempirical (or Low-Level LL) and ab initio/DFT (or High-Level HL). So far, the only program interfaced with amk to perform the ab initio/DFT calculations is G09. Therefore, if you want to perform the HL calculations G09 should be installed and should run like in this example: g09<inputfile>outputfile.

These packages might also be useful to analyze the results:

molden, sqlitebrowser

Installation

Once the above packages are installed, either:

Go to AutoMeKin if you cloned it from github

cd AutoMeKin

or go to the amk-SOURCE-2018 folder, if you downloaded the tarball.

cd amk-SOURCE-2018

In both cases, the process continues the same way. Now type:

./configure

This will install amk in $HOME/amk-2018 by default. If you want to install it in a different directory, type:

./configure --prefix=path_to_program

Finally, complete the installation:

make
make install
make clean

The last command (make clean) is only necessary if you want to remove from the src directory the object files and executables created in the compilation process.

For convenience, and once “Environment Modules” has been installed, you should add the following line to your .bashrc file:

module use path_to_program/modules

where path_to_program is the path where you installed amk (e.g., $HOME/amk-2018).

Running the test

To run the formic acid test example (explained in the tutorial ) for a few trajectories follow these steps:

1) Load the module:

module load amk/2018

2) Run the script if amk has been installed in $HOME:

run_test.sh

or

run_test.sh --prefix=path_to_program

otherwise.

This will create a directory named FA_test, where you can check the results (see the tutorial for details). The test may take a few minutes.


Return to AutoMeKin