installation.rst 1.99 KB
Newer Older
Marco Govoni's avatar
Marco Govoni committed
1
2
3
4
5
6
7
8
9
10
11
12
13
.. _installation:

============
Installation
============

In order to install WEST you need to download the `QuantumEspresso 6.1 <https://gitlab.com/QEF/q-e/-/archive/qe-6.1.0/q-e-qe-6.1.0.tar>`_.

`QuantumEspresso <http://www.quantum-espresso.org/>`_ (QE) is an integrated suite of Open-Source computer codes for electronic-structure calculations and materials modeling at the nanoscale, based on density-functional theory (DFT), plane waves (PW), and pseudopotentials (PP).
Configure QuantumEspresso by running the ``configure`` script that comes with the QE distribution. WEST requires `MPI <https://en.wikipedia.org/?title=Message_Passing_Interface>`_ support (`Scalapack <http://www.netlib.org/scalapack/>`_ and `OpenMP <http://openmp.org/>`_ support is also recommended, but optional). If all the environment variables (compilers, libraries etc.) have been set according to the QE configure guide, this would simply be:

.. code-block:: bash 

14
   $ git clone -b 'qe-6.1.0' --single-branch --depth 1 https://gitlab.com/QEF/q-e.git QEdir
Marco Govoni's avatar
Marco Govoni committed
15
   $ cd QEdir
Marco Govoni's avatar
Marco Govoni committed
16
   $ git clone -b 'v4.1.0' --single-branch --depth 1 http://greatfire.uchicago.edu/west-public/West.git West
Marco Govoni's avatar
Marco Govoni committed
17
   $ ./configure LD_LIBS="`python3-config --ldflags`"
Marco Govoni's avatar
Marco Govoni committed
18

Marco Govoni's avatar
Marco Govoni committed
19
.. note:: 
20
   Note that since v4.0.0 WEST requires dynamic linking and python3. 
Marco Govoni's avatar
Marco Govoni committed
21

Marco Govoni's avatar
Marco Govoni committed
22
23
24
25
26
27
28
It's now time to create the ``pw.x``, ``wstat.x``, ``wfreq.x``, and ``westpp.x`` executables by doing:

.. code-block:: bash 

   $ cd QEdir
   $ make pw
   $ cd QEdir/West
Marco Govoni's avatar
Marco Govoni committed
29
   $ make PYT=python3
Marco Govoni's avatar
Marco Govoni committed
30
31
32
33
34
35
36
37
38
39
40
41
42

You have succefully installed QuantumEspresso and WEST if you see the executables ``pw.x``, ``wstat.x``, ``wfreq.x``, and ``westpp.x`` created in the QEdir/bin directory.

.. code-block:: bash 

   $ ls QEdir/bin/
   pw.x
   wstat.x
   wfreq.x
   westpp.x
   ... (other content) ...

Congratulations, you are all set for running QuantumEspresso and WEST! 
Marco Govoni's avatar
Marco Govoni committed
43
44
45
46
47
48
49
50
51


Suggested configuration options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. toctree::
   :maxdepth: 1

   installations/theta.rst
52
   installations/midway.rst
53
   installations/macosx.rst