rad_point_kernel/mkdocs.yml at main · fusion-energy/rad_point_kernel · GitHub

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
site_name: Rad Point Kernel
site_description: Fast engineering estimates for neutron and photon shielding
site_url: https://fusion-energy.github.io/rad_point_kernel/
repo_url: https://github.com/fusion-energy/rad_point_kernel

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.svg
  palette:
    scheme: default
    primary: blue
  features:
    - content.code.copy
    - navigation.sections

nav:
  - Home: index.md
  - Theory:
    - Point kernel method: theory/point_kernel.md
    - Build-up factors: theory/buildup_factors.md
  - User guide:
    - Installation: guide/installation.md
    - Materials: guide/materials.md
    - Layers: guide/layers.md
    - Sources: guide/source_spectra.md
    - Transmission (photon): guide/photon_transmission.md
    - Transmission (neutron): guide/neutron_transmission.md
    - Flux (photon): guide/photon_flux.md
    - Flux (neutron): guide/neutron_flux.md
    - Dose (photon): guide/photon_dose.md
    - Dose (neutron): guide/neutron_dose.md
    - Dose (coupled): guide/coupled_dose.md
    - Calculate build-up with MC: guide/buildup_mc.md
    - Weight window generation: guide/weight_windows.md
    - Many thicknesses and extrapolation: guide/extrapolation.md
    - Caching MC results: guide/caching.md
    - Plotting results: guide/plotting.md
    - Shielding studies:
      - Overview: guide/studies/index.md
      - Single-layer study: guide/studies/single_layer.md
      - Multi-layer study: guide/studies/multi_layer.md
      - Variable material study: guide/studies/variable_material.md
  - API reference: api.md
  - Verification and validation:
    - Overview: vnv/index.md
    - Uncollided flux in void: vnv/uncollided_flux_in_void.md
    - Transmission in void: vnv/transmission_in_void.md
    - Beer-Lambert single slab: vnv/beer_lambert_single_slab.md
    - Neutron fit form quality: vnv/neutron_fit_quality.md
    - Primary-photon fit form quality: vnv/primary_photon_fit_quality.md
    - Secondary-photon fit form quality: vnv/secondary_photon_fit_quality.md

plugins:
  - search
  - markdown-exec

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - admonition
  - pymdownx.arithmatex:
      generic: true

extra:
  generator: false

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js