Manual/_quarto.yml at main · IPPL-framework/Manual · 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
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
project:
  type: book
  output-dir: docs
  pre-render:
    - tools/update_contributors.py

book:
  title: "IPPL Manual"
  subtitle: "Independent Parallel Particle Layer"
  description: "User and developer manual for the IPPL C++ particle and field library."
  site-url: "https://IPPL-framework.github.io/Manual/"
  repo-url: "https://github.com/IPPL-framework/Manual"
  repo-branch: main
  repo-actions: [edit, issue]
  favicon: figures/ippl-logo.png
  sidebar:
    collapse-level: 1
  chapters:
    - index.qmd

    - part: sections/introduction/index.qmd
      chapters:
        - sections/introduction/theory/index.qmd
        - sections/introduction/overview/index.qmd

    # - part: "Getting Started"
    - part: sections/getting-started/index.qmd
      chapters:
        - sections/getting-started/installation/index.qmd
        - sections/getting-started/hello-ippl/index.qmd
        - sections/getting-started/slurm/index.qmd

    - part: sections/ippl-core/index.qmd
      chapters:
        - sections/ippl-core/core-concepts/index.qmd
        - sections/ippl-core/fields/index.qmd
        - sections/ippl-core/particles/index.qmd
        - sections/ippl-core/communication/index.qmd

    - part: sections/methods-operators/index.qmd
      chapters:
        - sections/methods-operators/particle-mesh-interpolation/index.qmd
        - sections/methods-operators/differential-operators/index.qmd
        - sections/methods-operators/cg/index.qmd
        - sections/methods-operators/fft/index.qmd
        - file: sections/methods-operators/nufft/index.qmd
          text: "NUFFT"
        - sections/methods-operators/fem/index.qmd

    - part: sections/field-solvers/index.qmd
      chapters:
        - sections/field-solvers/poisson-solvers/index.qmd
        - sections/field-solvers/maxwell-solvers/index.qmd

    - part: sections/analysis-performance/index.qmd
      chapters:
        - sections/analysis-performance/profiling/index.qmd
        - sections/analysis-performance/in-situ/index.qmd

    - part: sections/tests/index.qmd
      chapters:
        - sections/tests/integration-tests/index.qmd
        - sections/tests/unit-tests/index.qmd

    - part: sections/demos/index.qmd
      chapters:
        - sections/demos/alpine/index.qmd
        - sections/demos/alpine-pif/index.qmd
        - sections/demos/cosmology/index.qmd
        - sections/demos/collisions/index.qmd
        - sections/demos/fel/index.qmd

    - part: sections/for-developers/index.qmd
      chapters:
        - sections/for-developers/developer-guide/index.qmd
        - sections/for-developers/workflow/index.qmd
        - sections/for-developers/writing-unit-tests/index.qmd
        - sections/for-developers/performance-portability/index.qmd
        - sections/for-developers/api-reference/index.qmd

    - part: sections/appendix/index.qmd
      chapters:
        - sections/appendix/literature/index.qmd
        - sections/appendix/contributors/index.qmd
        - sections/appendix/playground/index.qmd

number-sections: true
number-depth: 3

format:
  html:
    toc: true
    toc-depth: 3
    # toc-location: right
    number-sections: true
    html-math-method: mathjax
    code-fold: false
    theme:
      - cosmo
      - includes/styles.css

bibliography: references.bib
csl: csl/ieee.csl