/
mkdocs.yml
185 lines (174 loc) · 5.78 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# Project information
site_name: "Quantum KITE"
site_description: "KITE: Real-space quantum transport simulator"
site_author: "KITE"
# Repository
repo_url: https://github.com/quantum-kite/kite
edit_uri: https://github.com/quantum-kite/kite/tree/master/docs
# Copyright
copyright: "KITE is a free software: you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation - version 3. Copyright ©
2023 KITE"
# Navigation
nav:
- Home: 'index.md'
- Installation: 'installation.md'
- Documentation:
- Tutorial: 'documentation/index.md'
- 0. Ground Rules: 'documentation/optimization.md'
- 1. Workflow: 'documentation/workflow.md'
- 2. Lattice: 'documentation/tb_model.md'
- 3. Settings: 'documentation/settings.md'
- 4. Calculation: 'documentation/calculation.md'
- 5. Post-processing: 'documentation/postprocessing.md'
- 6. Disorder: 'documentation/disorder.md'
- 7. Magnetic Field: 'documentation/magnetic.md'
- 8. Editing the HDF5 file: 'documentation/editing_hdf_files.md'
- In Depth Examples:
- About the examples: 'documentation/examples/index.md'
- Graphene: 'documentation/examples/graphene.md'
- Haldane: 'documentation/examples/haldane.md'
- Phosphorene: 'documentation/examples/phosphorene.md'
- Optical Conductivity: 'documentation/examples/optical_conductivity.md'
- KITE scripts v.1.1:
- About Examples-dir: 'documentation/more_examples/additional_examples.md'
- Advanced Examples:
- Large Systems: 'documentation/more_examples/large_systems.md'
- Custom Local Potential: 'documentation/more_examples/custom_local_potential.md'
- Examples from KITE's Paper: 'documentation/more_examples/paper.md'
- Background:
- Overview of KITE: 'background/index.md'
- Spectral Methods: 'background/spectral.md'
- Tight-Binding Models: 'background/tight_binding.md'
- API:
- Overview: 'api/index.md'
- KITE (python):
- Python package: 'api/kite.md'
- KITEx:
- Main program: 'api/kitex.md'
- KITE-tools:
- Toolbox: 'api/kite-tools.md'
- Addtitional scripts: 'api/kite_tools_readme.md'
- FAQ: 'faq.md'
- About:
- About KITE: 'about/index.md'
- LICENSE.md: 'about/LICENSE.md'
- VERSION.md: 'about/VERSION.md'
# Configuration
site_dir: "../docs/"
theme:
name: material
language: "en"
logo: "assets/images/site/safari-pinned-tab.svg"
favicon: "assets/images/site/favicon.ico"
custom_dir: "docs/assets/theme_override/"
font:
text: Roboto
code: Roboto Mono
primary: "grey"
palette:
# scheme: Quantum-KITE
- media: "(prefers-color-scheme: light)" # (1)!
scheme: kite
accent: deep orange
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)" # (2)!
scheme: slate
accent: deep orange
toggle:
icon: material/toggle-switch
name: Switch to light mode
features:
- navigation.tabs
- navigation.top
- navigation.sections
- navigation.expand
# - navigation.instant problem with the homepage
- navigation.tracking
- toc.integrate
- toc.follow
icon:
admonition:
declaration-function: fontawesome/solid/book
declaration-class: fontawesome/solid/book
# Customization
extra_css:
- "assets/stylesheets/extra.css"
- "assets/stylesheets/monokai.css"
- "assets/stylesheets/colorful.css"
extra_javascript:
- assets/javascripts/mathjax-config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- https://unpkg.com/mermaid@7.1.2/dist/mermaid.min.js
# Extensions
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- admonition
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.arithmatex:
generic: true
- footnotes
- md_in_html
- def_list
- tables
- toc:
permalink: true
baselevel: 2
- attr_list
- meta
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
extra:
team:
- name: "Aires Ferreira"
title: Co-Founder
link: https://www.linkedin.com/in/aires-ferreira-52a1404/
image: ferreira.jpg
- name: "Tatiana G. Rappoport"
title: Co-Founder
link: https://www.linkedin.com/in/tatiana-rappoport-64242768/
image: rappoport.jpg
- name: "João M. Viana Parente Lopes"
title: Co-Founder
link: https://www.linkedin.com/in/joão-manuel-viana-parente-lopes-0770b34/
image: lopes.jpg
- name: "Lucian Covaci"
title: Co-Founder
link: https://www.linkedin.com/in/lucian-covaci-1439388a/
image: covaci.jpg
- name: "Simão M. João"
title: Co-Founder
link: https://sigarra.up.pt/fcup/pt/func_geral.formview?p_codigo=647225/
image: simao.jpg
- name: "Miša Anđelković"
title: Co-Founder
link: https://www.linkedin.com/in/misaandelkovic/
image: misa.jpg
- name: "João P. Santos Pires"
title: Contributor
link: https://www.linkedin.com/in/joão-pedro-dos-santos-pires-849898173/
image: pires.jpg
- name: "Bert Jorissen"
title: Contributor
link: https://bertjorissen.be
image: jorissen.jpg
- name: "Emile Aerts"
title: Contributor
link: https://www.uantwerpen.be/en/staff/emile-aerts_23098/
image: aerts.jpg
- name: "Robin Smeyers"
title: Contributor
link: https://be.linkedin.com/in/robin-smeyers-293bb8209/
image: smeyers.jpg
- name: "David T. S. Perkins"
title: Contributor
link: https://davidtsperkins.com/"
image: perkins.jpg