Main Page: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
No edit summary
 
(88 intermediate revisions by 9 users not shown)
Line 1: Line 1:
This front page should look something like [https://www.mediawiki.org/wiki/MediaWiki this] - CH, or anyone who wants to hack the WM theme
[[File:Yambo_teaches.png|thumb|center|upright=2.0|]]


=== About ===
Welcome to the Yambo educational page. In this page you will find several informations about how to run Yambo and, more generally, about the methods implemented in the code.
* [[Overview]]
* [[People]]
See Discussion


=== Learn ===
== Yambo Philosophy ==
* [[Fundamental theory]] - Pedro
The Yambo Philosophy is simple: '''read, learn, run, cite us'''!
Might require converting images of formulae to MathJax or whatever
* [[Lectures]] - Andrea
* [[Spectroscopy]] - Andrea (what is this? - see discussion)
* [[Tutorials]] - Myrta
* [[Highlights]] - AF
=== Get Started ===
* [[Download]] - AF
* [[Libraries]] - Davide
* [[Installation]] - Conor
** [[Configure]]


=== Running Yambo ===
Yambo is a tool but to use it you must first know as much as possible the theories, approximations and methods that are coded in the tool.  
* [[Flowchart]] - Myrta
* [[Interfaces]] - Davide
** [[p2y]] [[a2y]] [[c2y]] [[e2y]]
* [[Runlevels]] - Myrta
This, and input variables, is the most difficult part of the site to put together well. It will take some deeper planning


* [[Input variables]] - Conor (Doxygen)
'''Yambo should never be used without a clear understanding of the theory laying behind the code'''.
* [[Postprocessing]] - Maurizia
** [[exciton]] [[kpoints]] [[dos]] [[band structure]] [[wavefunctions]]
* [[Tools]] - Alejandro
** [[python]]
** [[perl]]
** [[shell]]


=== Support ===
This is exactly the aim of this wiki page. To guide the general Yambo user, advanced or not, in a detailed tour of the Yambo features.
* [[FAQs]] - Daniele
Conor: my great hope is that the FAQ section will cut a lot of the posts to the forum, so structure it well...
* [[User Forum]] - Daniele (This can be simply a link to the forum!)
* [[Acknowledge]]
* [[Publications]] - Daniele


=== News ===
== Read ==
* [[Latest news]]  
Reading is the basic ingredient. Here we provide some elemental references of the theories/methods used in Yambo:
* [[Theory|Background theory]]
* [[Lectures|Lectures on various topics by the Yambo team]]
* [[Tutorials| Tutorials]]
* [[Selected Readings|Other reading material]]
* [[Cheatsheets|Cheatsheets: Relating theory and code variables]]
* [[Thesis]]


=== Developers' Corner ===
== Learn ==
* [[Test suite]]
The second step in the philosophy are the tutorials. These can be run standalone or via a Yambo-specific Virtual Machine
* [[Coding guidelines]] - Davide, Conor
* [[Tutorials]]
** [[Doxygen]]
* [[Yambo_Virtual_Machine|A Yambo-based Virtual Machine]]
* [[Performance]] - Fabio
* [[Subversion]] - Structure and management of code, GPL generation
* [[Projects]]


== Run ==
* [[Download]]
* [[Installation]]
* If you find a '''bug''' or a '''weird behaviour''' in Yambo please report it in the [http://www.yambo-code.eu/forum/ Forum]
* If you get a '''segmentation fault''' please read this page: [[Identify what's causing segmentation fault in Yambo]]


== Cite us ==
It is scientifically fair to ''cite the two following articles in any publication based on results obtained with Yambo''


* {{article
|title= Many-body perturbation theory calculations using the yambo code
|authors=Davide Sangalli, Andrea Ferretti, Henrique Miranda, Claudio Attaccalite, Ivan Marri, Elena Cannuccia, Pedro Miguel Melo, Margherita Marsili, Fulvio Paleari, Antimo Marrazzo, Gianluca Prandini, Pietro Bonfà, Michael O Atambo, Fabio Affinito, Maurizia Palummo, Alejandro Molina-Sanchez, Conor Hogan, Myrta Grüning, Daniele Varsano, Andrea Marini
|journal= Journal of Physics: Condensed Matter
|volume=  31
|pages= 325902
|year=  2019
|doi=10.1088/1361-648x/ab15d0
}}


* {{article
|title= Yambo: an ab initio tool for excited state calculations
|authors=Andrea Marini, Conor Hogan, Myrta Grüning, Daniele Varsano
|journal= Comp. Phys. Comm.
|volume=  144
|pages= 180
|year=  2009
|doi=10.1016/j.cpc.2009.02.003
}}


 
Check the [http://www.researcherid.com/rid/O-4564-2015 Yambo researcher ID page] for citation information.
 
== Getting started ==
* [//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [//www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [//www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]

Latest revision as of 12:10, 14 September 2023

Yambo teaches.png

Welcome to the Yambo educational page. In this page you will find several informations about how to run Yambo and, more generally, about the methods implemented in the code.

Yambo Philosophy

The Yambo Philosophy is simple: read, learn, run, cite us!

Yambo is a tool but to use it you must first know as much as possible the theories, approximations and methods that are coded in the tool.

Yambo should never be used without a clear understanding of the theory laying behind the code.

This is exactly the aim of this wiki page. To guide the general Yambo user, advanced or not, in a detailed tour of the Yambo features.

Read

Reading is the basic ingredient. Here we provide some elemental references of the theories/methods used in Yambo:

Learn

The second step in the philosophy are the tutorials. These can be run standalone or via a Yambo-specific Virtual Machine

Run

Cite us

It is scientifically fair to cite the two following articles in any publication based on results obtained with Yambo

  • Many-body perturbation theory calculations using the yambo code, Davide Sangalli, Andrea Ferretti, Henrique Miranda, Claudio Attaccalite, Ivan Marri, Elena Cannuccia, Pedro Miguel Melo, Margherita Marsili, Fulvio Paleari, Antimo Marrazzo, Gianluca Prandini, Pietro Bonfà, Michael O Atambo, Fabio Affinito, Maurizia Palummo, Alejandro Molina-Sanchez, Conor Hogan, Myrta Grüning, Daniele Varsano, Andrea Marini, Journal of Physics: Condensed Matter 31, 325902 (2019).

Check the Yambo researcher ID page for citation information.

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