Difference between revisions of "First steps in Yambopy"

From The Yambo Project
Jump to navigation Jump to search
(34 intermediate revisions by 7 users not shown)
Line 1: Line 1:
Enter in a node and create in the scratch a folder
The yambopy project aims to develop python tools to:


<source lang="python">
* Read and edit yambo and quantum espresso input files
ssh -Y tutoXY@cecam; ssh -Y node0XY
* Easily perform pre- and post-processing of the simulation data for these two codes - including hard-to-get, database-encoded data beyond standard outputs
cd /home/scratch
* Provide easy visualization and plotting options
mkdir your_name; cd your_name
* Set up simple automatization workflows (e.g., convergence tests)
</source>


You clone yambopy from the git repository
=== Setup ===
First of all, make sure that you have a suitable python environment (crated for example with [https://docs.conda.io/projects/miniconda/en/latest/| conda] or [https://docs.python.org/3/library/venv.html| venv]) with python >=3.8.


<source lang="python">
Then, you may install yambopy in one of the following ways.
git clone https://github.com/henriquemiranda/yambo-py.git
</source>


You enter into the yambopy folder and install
==== Quick installation from PyPI repository ====


<source lang="python">
* In order to quickly install the officially released version type:
cd yamboypy
python setup.py install --user
</source>


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


<source lang="python">
==== Installation from tarball ====
cd tutorial/bn
</source>


And go to [[GW tutorial. Convergence and approximations (BN)]] or [[Bethe-Salpeter equation tutorial. Optical absorption (BN)]].
* In case you don't want to download from the pip repository and prefer to install a version of yambopy locally, you may download the appropriate tarball from the [https://github.com/yambo-code/yambopy/releases| yambopy github page]. Extract the tarball, enter the yambopy folder and type <code>pip install .</code>
 
==== Installation of latest patch ====
 
* In case you want the latest version of the code including new updates and patches that might not be present in the official version, then you can clone the yambopy git repository (a basic knowledge of git may be helpful):
 
git clone https://github.com/yambo-code/yambopy.git
cd yambopy
pip install .
 
==== Dependencies ====
 
* In principle, <code>pip</code> should take care of the required python dependencies. They are <code>numpy</code>, <code>scipy</code>, <code>matplotlib</code>, <code>netCDF4</code>, <code>lxml</code>, <code>PyYAML</code> and <code>monty</code>. In case some dependency-related problem arises, you can install each of them separately beforehand with:
 
pip install <code>dependency-name</code>
 
=== Tutorials ===
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:
* [[GW tutorial. Convergence and approximations (BN)]]
* [[Bethe-Salpeter equation tutorial. Optical absorption (BN)]]
* [[Yambopy tutorial: band structures | Database and plotting tutorial for quantum espresso: qepy]] (Get the databases: [https://media.yambo-code.eu/educational/tutorials/files/databases_qepy.tar.gz databases_qepy], 46.5MB)
* [[Yambopy tutorial: Yambo databases | Database and plotting tutorial for yambo: yambopy ]] (Get the databases: [https://media.yambo-code.eu/educational/tutorials/files/databases_yambopy.tar.gz databases_yambopy], 129MB)
* [[Phonon-assisted luminescence by finite atomic displacements]]

Revision as of 14:05, 7 February 2024

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)

Setup

First of all, make sure that you have a suitable python environment (crated for example with conda or venv) with python >=3.8.

Then, you may install yambopy in one of the following ways.

Quick installation from PyPI repository

  • In order to quickly install the officially released version type:
pip install yambopy

Installation from tarball

  • In case you don't want to download from the pip repository and prefer to install a version of yambopy locally, you may download the appropriate tarball from the yambopy github page. Extract the tarball, enter the yambopy folder and type pip install .

Installation of latest patch

  • In case you want the latest version of the code including new updates and patches that might not be present in the official version, then you can clone the yambopy git repository (a basic knowledge of git may be helpful):
git clone https://github.com/yambo-code/yambopy.git
cd yambopy
pip install .

Dependencies

  • In principle, pip should take care of the required python dependencies. They are numpy, scipy, matplotlib, netCDF4, lxml, PyYAML and monty. In case some dependency-related problem arises, you can install each of them separately beforehand with:
pip install dependency-name

Tutorials

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://www.yambo-code.eu/wiki/index.php?title=First_steps_in_Yambopy&oldid=7624"