From 2b4e815273390ea1ebb8056739d288fc89d311f1 Mon Sep 17 00:00:00 2001
From: Michael Wimmer <wimmer@lorentz.leidenuniv.nl>
Date: Fri, 6 Sep 2013 12:15:15 +0200
Subject: [PATCH] add tutorial name (and number) to tutorial examples

---
 doc/source/tutorial/ab_ring.py                       |  3 +++
 doc/source/tutorial/band_structure.py                |  3 +++
 doc/source/tutorial/closed_system.py                 |  3 +++
 doc/source/tutorial/graphene.py                      |  3 +++
 doc/source/tutorial/plot_graphene.py                 |  3 +++
 doc/source/tutorial/plot_zincblende.py               | 11 +++++++++++
 doc/source/tutorial/quantum_well.py                  |  3 +++
 doc/source/tutorial/quantum_wire.py                  |  3 +++
 doc/source/tutorial/quantum_wire_revisited.py        |  3 +++
 doc/source/tutorial/spin_orbit.py                    |  3 +++
 doc/source/tutorial/superconductor_band_structure.py |  3 +++
 doc/source/tutorial/superconductor_transport.py      |  3 +++
 12 files changed, 44 insertions(+)

diff --git a/doc/source/tutorial/ab_ring.py b/doc/source/tutorial/ab_ring.py
index 69aeb9c..bd23bbf 100644
--- a/doc/source/tutorial/ab_ring.py
+++ b/doc/source/tutorial/ab_ring.py
@@ -1,3 +1,6 @@
+# Tutorial 2.3.3. Nontrivial shapes
+# =================================
+#
 # Physics background
 # ------------------
 #  Flux-dependent transmission through a quantum ring
diff --git a/doc/source/tutorial/band_structure.py b/doc/source/tutorial/band_structure.py
index 8bdfb56..ddb9976 100644
--- a/doc/source/tutorial/band_structure.py
+++ b/doc/source/tutorial/band_structure.py
@@ -1,3 +1,6 @@
+# Tutorial 2.4.1. Band structure calculations
+# ===========================================
+#
 # Physics background
 # ------------------
 #  band structure of a simple quantum wire in tight-binding approximation
diff --git a/doc/source/tutorial/closed_system.py b/doc/source/tutorial/closed_system.py
index abe9114..2f54bf0 100644
--- a/doc/source/tutorial/closed_system.py
+++ b/doc/source/tutorial/closed_system.py
@@ -1,3 +1,6 @@
+# Tutorial 2.4.2. Closed systems
+# ==============================
+#
 # Physics background
 # ------------------
 #  Fock-darwin spectrum of a quantum dot (energy spectrum in
diff --git a/doc/source/tutorial/graphene.py b/doc/source/tutorial/graphene.py
index 2c652d0..3d52c0c 100644
--- a/doc/source/tutorial/graphene.py
+++ b/doc/source/tutorial/graphene.py
@@ -1,3 +1,6 @@
+# Tutorial 2.5. Beyond square lattices: graphene
+# ==============================================
+#
 # Physics background
 # ------------------
 #  Transport through a graphene quantum dot with a pn-junction
diff --git a/doc/source/tutorial/plot_graphene.py b/doc/source/tutorial/plot_graphene.py
index 0f36ec7..452e502 100644
--- a/doc/source/tutorial/plot_graphene.py
+++ b/doc/source/tutorial/plot_graphene.py
@@ -1,3 +1,6 @@
+# Tutorial 2.7.1. 2D example: graphene quantum dot
+# ================================================
+#
 # Physics background
 # ------------------
 #  - graphene edge states
diff --git a/doc/source/tutorial/plot_zincblende.py b/doc/source/tutorial/plot_zincblende.py
index fc05e36..7ffeae2 100644
--- a/doc/source/tutorial/plot_zincblende.py
+++ b/doc/source/tutorial/plot_zincblende.py
@@ -1,3 +1,14 @@
+# Tutorial 2.7.2. 3D example: zincblende structure
+# ================================================
+#
+# Physical background
+# -------------------
+#  - 3D Bravais lattices
+#
+# Kwant features highlighted
+# --------------------------
+#  - demonstrate different ways of plotting in 3D
+
 import kwant
 from matplotlib import pyplot
 
diff --git a/doc/source/tutorial/quantum_well.py b/doc/source/tutorial/quantum_well.py
index 50001f7..76ab616 100644
--- a/doc/source/tutorial/quantum_well.py
+++ b/doc/source/tutorial/quantum_well.py
@@ -1,3 +1,6 @@
+# Tutorial 2.3.2. Spatially dependent values through functions
+# ============================================================
+#
 # Physics background
 # ------------------
 #  transmission through a quantum well
diff --git a/doc/source/tutorial/quantum_wire.py b/doc/source/tutorial/quantum_wire.py
index 22e3909..d4d8995 100644
--- a/doc/source/tutorial/quantum_wire.py
+++ b/doc/source/tutorial/quantum_wire.py
@@ -1,3 +1,6 @@
+# Tutorial 2.2.2. Transport through a quantum wire
+# ================================================
+#
 # Physics background
 # ------------------
 #  Conductance of a quantum wire; subbands
diff --git a/doc/source/tutorial/quantum_wire_revisited.py b/doc/source/tutorial/quantum_wire_revisited.py
index c524256..c42912c 100644
--- a/doc/source/tutorial/quantum_wire_revisited.py
+++ b/doc/source/tutorial/quantum_wire_revisited.py
@@ -1,3 +1,6 @@
+# Tutorial 2.2.3. Building the same system with less code
+# =======================================================
+#
 # Physics background
 # ------------------
 #  Conductance of a quantum wire; subbands
diff --git a/doc/source/tutorial/spin_orbit.py b/doc/source/tutorial/spin_orbit.py
index 5b1ddbf..0112d3f 100644
--- a/doc/source/tutorial/spin_orbit.py
+++ b/doc/source/tutorial/spin_orbit.py
@@ -1,3 +1,6 @@
+# Tutorial 2.3.1. Matrix structure of on-site and hopping elements
+# ================================================================
+#
 # Physics background
 # ------------------
 #  Gaps in quantum wires with spin-orbit coupling and Zeeman splititng,
diff --git a/doc/source/tutorial/superconductor_band_structure.py b/doc/source/tutorial/superconductor_band_structure.py
index 827ed61..9f8da5e 100644
--- a/doc/source/tutorial/superconductor_band_structure.py
+++ b/doc/source/tutorial/superconductor_band_structure.py
@@ -1,3 +1,6 @@
+# Tutorial 2.6.1. Superconductors - "Orbital description": using matrices
+# =======================================================================
+#
 # Physics background
 # ------------------
 #  band structure of a superconducting quantum wire in tight-binding
diff --git a/doc/source/tutorial/superconductor_transport.py b/doc/source/tutorial/superconductor_transport.py
index 3f95387..505479e 100644
--- a/doc/source/tutorial/superconductor_transport.py
+++ b/doc/source/tutorial/superconductor_transport.py
@@ -1,3 +1,6 @@
+# Tutorial 2.6.2. "Lattice description": using different lattices
+# ===============================================================
+#
 # Physics background
 # ------------------
 # - conductance of a NS-junction (Andreev reflection, superconducting gap)
-- 
GitLab