forked from ukaea/PROCESS
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
216 lines (207 loc) · 9.13 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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
---
site_name: PROCESS
docs_dir: documentation/proc-pages/
nav:
- Getting Started:
- About: index.md
- Installation:
- Introduction: installation/introduction.md
- Installation on Ubuntu/Windows: installation/installation-ubuntu.md
- Installation on CSD3: installation/csd3-for-process.md
- Visual Studio Code: installation/vs-code.md
- Usage:
- Running PROCESS: usage/running-process.md
- Examples: usage/examples.md
- Troubleshooting: usage/troubleshooting.md
- Plotting: usage/plotting.md
- Tracking: tracking.html
- I/O:
- Input: io/input-guide.md
- Output: io/output-guide.md
- Python Libraries: io/python-lib-guide.md
- Utilities: io/utilities.md
- Variable Descriptions: io/vardes.md
- Development:
- Git:
- Usage: development/git-usage.md
- Pre-commit: development/pre-commit.md
- Continuous Integration: development/ci-guide.md
- Maintenance:
- Testing: development/testing.md
- Debugging: development/debugging.md
- Tools: development/tools.md
- Code modification:
- Adding Variables & Constraints: development/add-vars.md
- Adding Physics and Engineering Variables to Python: development/annotated-variable.md
- Python Optimisation and Numba: development/numba.md
- Style:
- Standards: development/standards.md
- F2Py Standards: development/f2py-standards.md
# - Versioning: development/versioning.md
- Models:
- Physics Models:
- Plasma:
- Overview: physics-models/plasma_overview.md
- Geometry: physics-models/plasma_geometry.md
- Profiles:
- Overview: physics-models/profiles/plasma_profiles.md
- Density Profile: physics-models/profiles/plasma_density_profile.md
- Temperature Profile: physics-models/profiles/plasma_temperature_profile.md
- Profile Base Class: physics-models/profiles/plasma_profiles_abstract_class.md
- Fusion Reactions:
- Overview: physics-models/fusion_reactions/plasma_reactions.md
- Beam reactions: physics-models/fusion_reactions/beam_reactions.md
- Bosch-Hale Methods: physics-models/fusion_reactions/plasma_bosch_hale.md
- Beta Limit: physics-models/plasma_beta.md
- Fast Alpha: physics-models/plasma_alpha.md
- Density Limit: physics-models/plasma_density.md
- Composition, Impurities & Radiation: physics-models/plasma_radiation_impurities.md
- Plasma Current:
- Overview: physics-models/plasma_current/plasma_current.md
- Bootstrap Current: physics-models/plasma_current/bootstrap_current.md
- Diamagnetic Current: physics-models/plasma_current/diamagnetic_current.md
- Pfirsch-Schlüter Current: physics-models/plasma_current/pfirsch_schlüter_current_drive.md
- Inductive Current: physics-models/plasma_current/inductive_plasma_current.md
- Confinement time: physics-models/plasma_confinement.md
- Plasma Core Power Balance: physics-models/plasma_power_balance.md
- Pulsed Plant Operation: physics-models/pulsed-plant.md
- Engineering Models:
- Machine Build: eng-models/machine-build.md
- Structural Components: eng-models/structural-components.md
- Buildings: eng-models/buildings.md
- First Wall/Blanket: eng-models/fw-blanket.md
- TF Coil: eng-models/tf-coil.md
- PF Coil: eng-models/pf-coil.md
- Central Solenoid: eng-models/central-solenoid.md
- Shield: eng-models/shield.md
- Divertor: eng-models/divertor.md
- Heat transport: eng-models/power-conversion-and-heat-dissipation-systems.md
- Auxiliary Heating & Current Drive Systems:
- Overview: eng-models/heating_and_current_drive/heating-and-current-drive.md
- Radio Frequency:
- Overview: eng-models/heating_and_current_drive/RF/rf_overview.md
- Lower Hybrid:
- Overview: eng-models/heating_and_current_drive/RF/lhcd_overview.md
- Fenstermacher Model: eng-models/heating_and_current_drive/RF/fenstermacher_lower_hybrid.md
- Ehst Model: eng-models/heating_and_current_drive/RF/ehst_lower_hybrid.md
- Culham Model: eng-models/heating_and_current_drive/RF/culham_lower_hybrid.md
- Electron Cyclotron:
- Overview: eng-models/heating_and_current_drive/RF/ec_overview.md
- Fenstermacher Resonnance Model: eng-models/heating_and_current_drive/RF/fenstermacher_electron_cyclotron_resonance.md
- Culham Model: eng-models/heating_and_current_drive/RF/culham_electron_cyclotron.md
- User Input Gamma Model: eng-models/heating_and_current_drive/RF/ecrh_gamma.md
- Cutoff mode: eng-models/heating_and_current_drive/RF/cutoff_ecrh.md
- Ion Cyclotron:
- Overview: eng-models/heating_and_current_drive/RF/ic_overview.md
- Ion cyclotron model: eng-models/heating_and_current_drive/RF/ic_model.md
- Electron Bernstein Wave:
- Overview: eng-models/heating_and_current_drive/RF/ebw_overview.md
- EBW Model: eng-models/heating_and_current_drive/RF/ebw_freethy.md
- Neutral Beam Injection:
- Overview: eng-models/heating_and_current_drive/NBI/nbi_overview.md
- ITER Model: eng-models/heating_and_current_drive/NBI/iter_nb.md
- Culham Model: eng-models/heating_and_current_drive/NBI/culham_nb.md
- Cryostat and vacuum system: eng-models/cryostat-and-vacuum-system.md
- Plant Availability: eng-models/plant-availability.md
- Power Requirements: eng-models/power-requirements.md
- Vacuum Vessel: eng-models/vacuum-vessel.md
- Unique Models:
- Water Use: unique-models/water_use.md
- Power Plant Building Sizes: unique-models/buildings_sizes.md
- Cost Models: cost-models/cost-models.md
- Solver:
- Solver Guide: solver/solver-guide.md
- VMCON Optimisation Solver Explained: solver/optsolverdoc.md
- Equation Solvers: solver/equation-solver.md
- Fusion Devices:
- Spherical Tokamak: fusion-devices/spherical-tokamak.md
- Stellarator Model: fusion-devices/stellarator.md
- Inertial Fusion Energy Model: fusion-devices/inertial.md
- Publications: publications.md
- Source Documentation:
- FORD Documentation: ford_site
- process: python/process.md
- process.io: python/process.io.md
- process.utilities: python/process.utilities.md
- process.fortran: python/process.fortran.md
# repo_url: https://git.ccfe.ac.uk/process/process.git
repo_url: https://github.com/UKAEA/PROCESS
repo_name: UKAEA/PROCESS
copyright: Copyright © 2023 United Kingdom Atomic Energy Authority
theme:
# name: readthedocs
name: material
font:
text: Roboto
features:
- navigation.tabs
- navigation.footer
- navigation.top
# - navigation.sections
- search.suggest
- search.highlight
- navigation.instant
- navigation.indexes
palette:
primary: indigo
accent: indigo
icon:
repo: fontawesome/brands/git-alt
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/squirrel-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML
markdown_extensions:
- footnotes
- admonition
- codehilite
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- attr_list
- pymdownx.emoji:
- md_in_html
plugins:
- autorefs
- search
- glightbox:
touchNavigation: true
effect: zoom
zoomable: true
auto_caption: true
caption_position: bottom
- git-revision-date-localized:
enable_creation_date: true
# - mkdocstrings:
# handlers:
# python:
# selection:
# docstring_style: restructured-text
# rendering:
# show_source: false
# show_root_heading: true
extra_css: [stylesheets/vardes.css]