First steps in Yambopy

From The Yambo Project
Jump to navigation Jump to search

The yambopy project aims to develop python tools to:

  • Read and edit yambo and quantum espresso input files
  • Easily perform pre- and post-processing of the simulation data for these two codes - including hard-to-get, database-encoded data beyond standard outputs
  • Provide easy visualization and plotting options
  • Set up simple automatization workflows (e.g., convergence tests)

Quick installation

A quick way to start using Yambopy is described here.

  • Make sure that you are using Python 3 and that you have the following python packages: numpy, scipy, matplotlib, netCDF4, lxml, pyyaml. Optionally, you may want to have abipy [[1]] installed for band structure interpolations.
  • Go to a directory of your choice and clone yambopy from the git repository
git clone

If you don't want to use git, you may download a tarball from the git repository instead.

  • Enter into the yambopy folder and install
cd yambopy
sudo python install

If you don't have administrative privileges (for example on a computing cluster), type instead

cd yambopy
python install --user

Frequent issues

When running the installation you may get a SyntaxError related to utf-8 encoding or it may complain that module setuptools is not installed even though it is. In this case, it means that the sudo command is not preserving the correct PATH for your python executable.

Solve the problem by running the installation step as

sudo /your/path/to/python install


sudo env PATH=$PATH python install

This applies only to the installation step and not to subsequent yambopy use.

Installing dependencies with Anaconda

We suggest installing yambopy using Anaconda [[2]] to manage the various python packages.

In this case, you can follow these steps.

First, install the required dependencies:

conda install numpy scipy netcdf4 lxml pyyaml

Then we create a conda environment based on python 3.6 (this is to ensure compatibility with abipy if we want to install it later on):

conda create --name NAME_ENV python=3.6

Here choose NAME_ENV as you want, e.g. yenv.

Now, we install abipy and its dependency pymatgen using pip. Here make sure that you are using the pip version provided by Anaconda and not your system version.

pip install pymatgen
pip install abipy

Finally, we are ready to install yambopy:

git clone 

(or download and extract tarball) and follow the steps outlined in the quick installation section.

Setup complete

Now yambopy is ready to use! Just go to the tutorials folder and follow the docs!

cd tutorial/

On this wiki, we provide steps for the following tutorials: