.. _installation:
Introduction
============
The EON project is divided into two separate programs: a server and a client. The client does most of the computations, while the server creates the input files for the EON client.
Dependencies
============
Check your system or cluster for the following required packages:
Server Requirements
-------------------
- `Python `__ (:math:`\geq 3.5`)
- `NumPy `__ (:math:`\geq 1.2.1`)
- `ASE `__
- `PyYaml `__
- `mpi4py `__ (optional, for MPI communicator)
Client Requirements
-------------------
- GNU Make
- G++ (:math:`\geq 4.0`, recommended; other C++ compilers may work)
- Gfortran or Intel Fortran Compiler (optional)
- `LAMMPS `__ (optional, for LAMMPS potentials)
- `pybind11 `__ (optional, for ASE interface)
EON Server Installation
=======================
User Installation
-----------------
We recommend installing EON in your ``$HOME`` directory. The latest developer version can be downloaded using:
.. code-block:: bash
cd $HOME
git clone https://github.com/henkelmangroup/eon.git
Verify that your ``$HOME`` directory contains the ``/eon`` folder using the ``ls`` command. The ``/eon`` directory needs to be added to your ``$PYTHONPATH`` and ``$PATH``. Modify your ``~/.bashrc`` file:
.. code-block:: bash
vim ~/.bashrc
Append these lines:
.. code-block:: bash
export PYTHONPATH=$HOME/eon:$PYTHONPATH
export PATH=$HOME/eon/bin:$PATH
Save and reload:
.. code-block:: bash
source ~/.bashrc
Now, install EON using Python’s package manager:
.. code-block:: bash
cd eon
pip install --user . # Note: there's a period "." after --user
Check installation:
.. code-block:: bash
pip show eon
which eon
Expected output:
.. code-block:: text
Name: eon
Version: 1.1.2549
Summary:
Home-page: https://henkelmangroup.github.io/eon/
Author: Henkelman Group
Location: $HOME/eon
NOTE: The version number will differ depending on the current release. Your ``eon`` executable is located in ``$HOME/eon/bin``.
Global Installation
-------------------
For a system-wide installation (requires root access):
.. code-block:: bash
cd eon
sudo python setup.py install
After installation, verify it with:
.. code-block:: bash
pip show eon
which eon
EONClient Installation
======================
The client source code is located in ``$HOME/eon/client``. Build it with:
.. code-block:: bash
cd $HOME/eon/client
make
For most installations, move the binary to ``$PATH``:
.. code-block:: bash
cp eonclient ../bin/eonclient
Alternatively, specify the client binary path in ``config.ini``.
Fortran Support
---------------
If using Fortran-dependent potentials, a Fortran compiler is required. To compile without Fortran support:
.. code-block:: bash
make NO_FORTRAN=1
For Intel Fortran Compiler (ifort), modify ``Makefile``:
- ``FC`` (Fortran compiler)
- ``FFLAGS`` (Fortran compiler flags)
- ``FAR`` (Fortran archiver)
ASE Calculator
==============
To use ASE calculators in EON, additional dependencies and a modified ``Makefile`` are required. Refer to the `ASE Interface `__ documentation.
LAMMPS Potential
================
To use a LAMMPS potential, build the appropriate library version of LAMMPS. For details, see the `LAMMPS Potential `__ page.
MPI Communicator
================
For using MPI communicator for parallel jobs, see the `MPI Communicator `__ documentation.
Test Run
========
Test run instructions are available in the `Tutorial `__ page.
.. _installation:
============
Installation
============
Eon is divided up into two separate programs: a server and a client. The client
does most of the computation (`e.g.` saddle searches, minimizations, and
molecular dynamics) while the server creates the input for the client and
processes its results.
Dependencies
============
* Server
* `Python `_ (>=3.5)
* `NumPy `_ (>=1.2.1)
* `ASE `_
* `PyYaml `_
* (optional, for MPI communicator) `mpi4py `_
* Client
* GNU Make
* G++ (>=4.0, other C++ compilers might work)
* (optional) gfortran or Intel Fortran Compiler
* (optional, for LAMMPS potentials) `LAMMPS `_
* (optional, for ASE interface) `Python `_ , `pybind11 `_
.. highlight:: bash
Server Installation
===================
We recommend installing Eon to your ``$HOME`` folder. To download the
latest developer version to your home folder::
$ cd $HOME
$ git clone https://github.com/henkelmangroup/eon.git
The directory ``$HOME/eon`` needs to be added to your ``$PYTHONPATH``
environment variable. It is also recommended to add ``$HOME/eon/bin`` to your
``$PATH``. This can be done permanently by appending the following to your
``~/.profile`` file::
export PYTHONPATH=$HOME/eon:$PYTHONPATH
export PATH=$HOME/eon/bin:$PATH
If you have root permissions, you can install Eon system-wide::
$ cd eon
$ sudo python setup.py install
This will install the eon python module to Python's site-package directory
as well as adding the ``eon`` program to your ``$PATH``.
Client Installation
===================
The client source code is located in a folder named ``client`` under the main
eon directory. For most situations, you will only need to run the make command
and a binary named ``client`` will be built in this directory::
$ cd client
$ make
If you wish to use the potentials that depend on fortran you will need a
fortran compiler. However, this is optional and you can compile the client
without fortran support by running the command ``make NO_FORTRAN=1``. If you
are using gfortran the supplied Makefile should work out of the box. If you are
using the Intel Fortran Compiler (ifort) you will need to edit the Makefile to
change ``FC`` (fortran compiler), ``FFLAGS`` (fortran compiler flags), and
``FAR`` (fortran archiver) variables to work for your system.
If you wish to use ASE calculators in EON, the additional dependencies (see above) and a modified Makefile is necessary.
Detailed documentation can be found on the :ref:`ASE Interface` page. [#ase1]_
If you wish to use a LAMMPS potential, you must first build the appropriate library version of LAMMPS. If the library will be used with a serial version of EON, then build the serial version of LAMMPS--likewise for MPI use.
Detailed documentation can be found on the :ref:`LAMMPS Potential` page. [#lammps1]_
If you want to use the MPI communicator, see the :ref:`MPI Communicator` page for instructions.
For most installations, the binary ``eonclient`` can be copied to a directory in your
``$PATH``. If you added ``$HOME/eon/bin`` to your path during the server installation the following command will install the client::
$ cp eonclient ../bin/eonclient
Otherwise you will need to give the path to the client binary in your
``config.ini``.
.. rubric :: References
.. [#ase1] `"Atomic Simulation Environment" `_
.. [#lammps1] `"Large-scale Atomic/Molecular Massively Parallel Simulator, Sandia National Laboratories" `_