Main Page: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
(created discussion page)
 
(94 intermediate revisions by 10 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|]]


''MG: I would put the content of the about on top of the page (in [https://www.mediawiki.org/wiki/MediaWiki the link you suggest] it would correspond to the welcome frame for example) rather than linking to other pages. At the end of the short about text I will have some meet the developer. I agree on the model page''
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.


'''I agree. This sort of discussion we can have in the Discussion tab, just created. Make a new section for other topics'''
== Yambo Philosophy ==
The Yambo Philosophy is simple: '''read, learn, run, cite us'''!


=== About ===
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.
* [[Overview]]
* [[People]]


=== Learn ===
'''Yambo should never be used without a clear understanding of the theory laying behind the code'''.
* [[Fundamental theory]] - Pedro
* [[Lectures]] - Andrea
* [[Spectroscopy]] - Andrea
* [[Tutorials]] - Myrta
* [[Highlights]] - AF


=== Get Started ===
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.
* [[Download]] - AF
* [[Libraries]] - Davide
* [[Installation]] - Conor
** [[Configure]]


=== Running Yambo ===
== Read ==
* [[Flowchart]] - Myrta
Reading is the basic ingredient. Here we provide some elemental references of the theories/methods used in Yambo:
* [[Interfaces]] - Davide
* [[Theory|Background theory]]
** [[p2y]] [[a2y]] [[c2y]] [[e2y]]
* [[Lectures|Lectures on various topics by the Yambo team]]
* [[Runlevels]] - Myrta
* [[Tutorials| Tutorials]]
This, and input variables, is the most difficult part of the site to put together well. It will take some deeper planning
* [[Selected Readings|Other reading material]]
* [[Cheatsheets|Cheatsheets: Relating theory and code variables]]
* [[Thesis]]


* [[Input variables]] - Conor (Doxygen)
== Learn ==
* [[Postprocessing]] - Maurizia
The second step in the philosophy are the tutorials. These can be run standalone or via a Yambo-specific Virtual Machine
** [[exciton]] [[kpoints]] [[dos]] [[wavefunctions]]  
* [[Tutorials]]
* [[Tools]] - Alejandro
* [[Yambo_Virtual_Machine|A Yambo-based Virtual Machine]]
** [[python]]
** [[perl]]
** [[shell]]


=== Support ===
== Run ==
* [[FAQs]] - Daniele
* [[Download]]  
Conor: my great hope is that the FAQ section will cut a lot of the posts to the forum, so structure it well...
* [[Installation]]
* [[User Forum]] - Daniele (This can be simply a link to the forum!)
* If you find a '''bug''' or a '''weird behaviour''' in Yambo please report it in the [http://www.yambo-code.eu/forum/ Forum]
* [[Acknowledge]]
* If you get a '''segmentation fault''' please read this page: [[Identify what's causing segmentation fault in Yambo]]
* [[Publications]] - Daniele


=== News ===
== Cite us ==
* [[Latest news]]
It is scientifically fair to ''cite the two following articles in any publication based on results obtained with Yambo''


=== Developers' Corner ===
* {{article
* [[Test suite]]
|title= Many-body perturbation theory calculations using the yambo code
* [[Coding guidelines]] - Davide, Conor
|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
** [[Doxygen]]
|journal= Journal of Physics: Condensed Matter
* [[Performance]] - Fabio
|volume=  31
* [[Subversion]] - Structure and management of code, GPL generation
|pages= 325902
* [[Projects]]
|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"