Download and Install
####################


Compatibility of EPWpy
======================

EPWpy is tested and should work on Mac, Linux (centos > 7.0), and Windows > 10. EPWpy requires python >= 3.8.
The packages which are essential for EPWpy functioning are
 * numpy
 * scipy
 * matplotlib
 * mp-api
 * mayavi (only if advanced visualization of wavefunctions is needed)
EPWpy installer installs these dependencies automatically.

To install EPWpy-1.0
====================

1. Download :download:`version 1.0 <https://gitlab.com/epwpy/epwpy/-/archive/epwpy-1.0/epwpy-1.0.tar.gz>` of EPWpy.
For this you can copy/paste the following on your terminal:

``wget https://gitlab.com/epwpy/epwpy/-/archive/epwpy-1.0/epwpy-1.0.tar.gz``

2. Unpack EPWpy. This can be done by copy/pasting the following lines:

``tar -xvzf epwpy-1.0.tar.gz && cd epwpy``

3. EPWpy can be installed as a library and can be called in a python script or a Jupyter notebook. Install EPWpy:

``python setup.py install``

4. The test-suite should be included in the download. 
You can then go inside the test-suite and run tests to make sure that everything works. 

``cd test-suite``
``make run-tests-local``

5. In calculations involving EPWpy you will need to direct EPWpy to a location where QE and EPW executables are present. However, EPWpy can itself download and build QE+EPW. To use this feature use:

``python setup.py install --with-QE <QE configuration>``

6. This will install QE+EPW in a folder called build inside the EPWpy folder. You will find executables inside:

``EPWpy/build/q-e/bin/``

Video tutorial
==============

.. raw:: html

    <iframe id="ytplayer" type="text/html" width="640" height="360"
    src="https://www.youtube.com/embed/q6kyn48KmgE?si=9CFfv7F4T9iDRX1y"
    frameborder="0"></iframe>
    
This video tutorial can also be found here: `<https://www.youtube.com/watch?v=q6kyn48KmgE&t=3s>`_