Lumen

Documentation Guide

Quick Navigation

• Theory Guide - Theoretical foundations
• Input Flags Reference - All configuration options
• I/O System - File formats and architecture
• Memory Management - Allocation system
• Real-Time Simulations - Time-dependent calculations
• API Reference - Code modules and procedures

Key Features

• GW Approximation - Quasiparticle corrections
• Bethe-Salpeter Equation - Excitonic effects
• Real-Time Dynamics - Non-linear optical responses
• Electron-Phonon Coupling - Transport properties
• Parallel & GPU - High-performance computing

Theory & Methods

• YAMBO Theory Documentation - Complete theory reference
• YAMBO Theory README - Introduction to theoretical framework
• YAMBO Theory Visual Guide - Visual representations
• YAMBO Theory Code Examples - Implementation examples

Real-Time Capabilities

• Real-Time Theory Documentation - Real-time propagation theory
• Real-Time Quick Reference - Real-time simulation guide
• YPP Real-Time Documentation - Post-processing tool guide
• YPP Real-Time Flowcharts - Processing workflows

I/O & Data Management

• IO System Architecture - Complete I/O infrastructure design
• IO System Flowchart - Visual workflow diagrams
• Input Flags Reference - Complete input flags listing
• IO Quick Reference - Common I/O procedures

Memory & Allocation System

• YAMBO Allocation Architecture - Memory management design
• YAMBO Allocation Documentation - Complete API reference
• YAMBO Allocation Examples - Practical usage examples
• YAMBO Allocation Quick Reference - Quick lookup card

Advanced Topics

• Two-Time Green Functions - Advanced correlation methods
• Kadanoff-Baym Implementation - Integro-differential solvers
• Formula Quick Reference - Essential equations

Support & Resources

• Official Website: https://www.yambo-code.eu/
• Community Forum: https://www.yambo-code.eu/forum/
• Wiki & Tutorials: https://www.yambo-code.eu/wiki/
• GitHub Repository: https://github.com/yambo-code/yambo

Citation

If you use Yambo in your research, please cite:

Yambo: An ab initio tool for excited state calculations of solids and nanostructures
A. Marini, C. Hogan, M. Grüning, D. Varsano
Computer Physics Communications, 180, 1392 (2009)

License & Authors

Yambo is distributed under the GNU General Public License v2.0 (GPL-2.0).
See the AUTHORS and COPYING files for details.

Version: 5.3 | Status: Production | Last Updated: 2025