Setting up Yambo: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
(Reorganization of sections)
 
Line 1: Line 1:
To able to follow the tutorials you need a running version of the yambo, yambopy (and QE or abinit codes).
To able to follow the tutorials you need a running version of the yambo, yambopy (and QE or abinit codes).
== Setting up Yambo (and eventually QE or abinit)  ==
There are several different ways to prepare a working environment.
There are several different ways to prepare a working environment.


=== Virtual Machine(s) ===
== Virtual Machine(s) ==
The easiest way is to access to a virtual machine which contains both (i) yambo/QE and (ii) the tutorials.
The easiest way is to access to a virtual machine which contains both (i) yambo/QE and (ii) the tutorials.


Line 18: Line 16:
-->
-->


=== User installation  ===
== User installation  ==
You can also setup the yambo code on your on laptop / desktop using different methods.
You can also setup the yambo code on your on laptop / desktop using different methods.


Line 26: Line 24:
* Install yambo on your laptop/desktop/cluster [https://github.com/nicspalla/my-repo via Spack].
* Install yambo on your laptop/desktop/cluster [https://github.com/nicspalla/my-repo via Spack].
* Install using  Anaconda.
* Install using  Anaconda.
== Setting up an environment ==
=== python env ===
You can create a python environment and activate it:
python -m venv MYPATH/yamboenv/
source MYPATH/yamboenv/bin/activate
=== conda env ===
As an alternative we suggest to consider conda environments.
To setup Anaconda, please start from installing [https://www.anaconda.com/products/distribution#Downloads Anaconda] or [https://docs.conda.io/en/latest/miniconda.html Miniconda].
Then to create a conda environment and activate it:
conda create --name yambo-env -c conda-forge
conda activate yambo-env


=== Yambo User Installation with Anaconda ===
=== Yambo User Installation with Anaconda ===
It is possible to install Yambo (up to v5.0.4) and Quantum-ESPRESSO via conda-forge (a conda channel/repository):
It is possible to install Yambo (up to v5.0.4) and Quantum-ESPRESSO via conda-forge (a conda channel/repository):
To setup Anaconda, please start from installing [https://www.anaconda.com/products/distribution#Downloads Anaconda] or [https://docs.conda.io/en/latest/miniconda.html Miniconda].


Then we suggest to create a conda environment and activate it:
conda create --name yambo-env -c conda-forge
conda activate yambo-env
Then you can install the prerequisites and the two codes:
Then you can install the prerequisites and the two codes:
  conda install numpy scipy netcdf4 matplotlib pyyaml lxml pandas
  conda install numpy scipy netcdf4 matplotlib pyyaml lxml pandas
Line 39: Line 48:
  conda install qe
  conda install qe


==Setting up Yambopy==
== Setting up Yambopy inside an enviroment ==


You can simply type in a suitable python environment.
You can simply type in a suitable python environment.


python -m venv MYPATH/yamboenv/
source MYPATH/yamboenv/bin/activate
  pip install yambopy
  pip install yambopy


For more information, go to the [[First steps in Yambopy| Yambopy setup page]].
For more information, go to the [[First steps in Yambopy| Yambopy setup page]].

Latest revision as of 12:01, 3 October 2024

To able to follow the tutorials you need a running version of the yambo, yambopy (and QE or abinit codes). There are several different ways to prepare a working environment.

Virtual Machine(s)

The easiest way is to access to a virtual machine which contains both (i) yambo/QE and (ii) the tutorials.

You can do it in one of two ways:

  • Virtual machine via ICTP cloud If the schools you are attending provided an ICTP virtual machine this is the preferred option. It works through internet connection inside a browser.
  • Install the yambo virtual machine on your laptop / desktop. This requires Oracle virtual box. Pre-download of the Virtual machine. No internet connection needed.

User installation

You can also setup the yambo code on your on laptop / desktop using different methods.

As far as the Yambo source is concerned you can:

Setting up an environment

python env

You can create a python environment and activate it:

python -m venv MYPATH/yamboenv/
source MYPATH/yamboenv/bin/activate

conda env

As an alternative we suggest to consider conda environments. To setup Anaconda, please start from installing Anaconda or Miniconda. Then to create a conda environment and activate it:

conda create --name yambo-env -c conda-forge
conda activate yambo-env

Yambo User Installation with Anaconda

It is possible to install Yambo (up to v5.0.4) and Quantum-ESPRESSO via conda-forge (a conda channel/repository):

Then you can install the prerequisites and the two codes:

conda install numpy scipy netcdf4 matplotlib pyyaml lxml pandas
conda install yambo 
conda install qe

Setting up Yambopy inside an enviroment

You can simply type in a suitable python environment.

pip install yambopy

For more information, go to the Yambopy setup page.