First steps in Yambopy: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
mNo edit summary
Line 10: Line 10:
A quick way to start using Yambopy is described here.
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: <code>numpy</code>, <code>scipy</code>, <code>matplotlib</code>, <code>netCDF4</code>, <code>lxml</code>, <code>pyyaml</code>. Optionally, you may want to have abipy [[https://abinit.github.io/abipy/index.html]] installed for band structure interpolations.
* Make sure that you are using Python 3, and follow the [https://www.yambo-code.eu/wiki/index.php/Tutorials#Advanced:_Setting_up_Only_YamboPy setup instructions for Yambopy]. The <code>abipy</code> [[https://abinit.github.io/abipy/index.html]] package is optional. You may however want to have it installed for band structure interpolations.
 
* Go to a directory of your choice and clone yambopy from the git repository
 
git clone https://github.com/yambo-code/yambopy.git
 
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 setup.py install
 
If you don't have administrative privileges (for example on a computing cluster), type instead
 
cd yambopy
python setup.py install --user


===Frequent issues===
===Frequent issues===
Line 40: Line 24:


===Installing dependencies with Anaconda===
===Installing dependencies with Anaconda===
We suggest installing yambopy using Anaconda [[https://www.anaconda.com/products/distribution]] to manage the various python packages.
We suggest that you install Yambopy using conda to automatically manage the dependencies, to do so, please follow the instructions for [https://www.yambo-code.eu/wiki/index.php/Tutorials#Setting_up_Yambopy:_Using_Anaconda Setting up Yambopy with Anaconda].  
 
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 <code>NAME_ENV</code> as you want, e.g. <code>yenv</code>.
 
Now, we install abipy and its dependency pymatgen using <code>pip</code>. Here make sure that you are using the <code>pip</code> version provided by Anaconda and not your system version.
 
pip install pymatgen
pip install abipy
 
Finally, we are ready to install yambopy:
 
git clone https://github.com/yambo-code/yambopy.git
 
(or download and extract tarball) and follow the steps outlined in the quick installation section.


===Setup complete===
===Setup complete===

Revision as of 11:37, 10 February 2023

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 follow the setup instructions for Yambopy. The abipy [[1]] package is optional. You may however want to have it installed for band structure interpolations.

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 setup.py install

or 

sudo env PATH=$PATH python setup.py install

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

Installing dependencies with Anaconda

We suggest that you install Yambopy using conda to automatically manage the dependencies, to do so, please follow the instructions for Setting up Yambopy with Anaconda.

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:

Retrieved from "https://wiki.yambo-code.eu/wiki/index.php?title=First_steps_in_Yambopy&oldid=6155"