pythia-foundations/myst.yml at main · ProjectPythia/pythia-foundations · 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
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
# See docs at: https://mystmd.org/guide/frontmatter
version: 1
extends:
  - https://raw.githubusercontent.com/projectpythia/pythia-config/main/pythia.yml
project:
  title: Pythia Foundations
  github: https://github.com/projectpythia/pythia-foundations
  bibliography:
    - references.bib
  authors:
    # The full author list is maintained in preamble/how-to-cite.md
    - The Project Pythia Community
  doi: https://doi.org/10.5281/zenodo.7884571
  copyright: '2024'
  jupyter:
    binder:
      url: https://binder.projectpythia.org
      repo: projectpythia/pythia-foundations
  settings:
    output_matplotlib_strings: remove
  abbreviations:
    API: Application Programming Interface
    CVS: Concurrent Versions System
    DOI: Digital Object Identifier
    FOSS: Free and Open-Source Software
    FTP: File Transfer Protocol
    HTTP: Hypertext Transfer Protocol
    ID: Identifier
    IDL: Interactive Data Language
    NCAR: NSF National Center for Atmospheric Research
    NCL: NCAR Command Language
    NSF: U.S. National Science Foundation
    NVIDIA: null
    PR: Pull Request
    SPE: Scientific Python Ecosystem
    SSH: Secure Shell Protocol
    SVN: Apache Subversion
    TCP: Transmission Control Protocol
    URL: Uniform Resource Locator
    VCS: Version Control System

  error_rules:
    - rule: link-resolves
      severity: ignore
      keys:
        - 'https://doi.org/**'
        - 'https://zenodo.org/**'
        - 'https://pangeo.io'
        - 'https://jupyterbook.org/'
        - 'https://github.com/alan-turing-institute/the-turing-way/blob/master/book/templates/chapter-template/chapter-landing-page.md'
        - 'https://the-turing-way.netlify.app'
        - 'https://github.com/numpy/numpy/blob/main/doc/source/_static/numpylogo.svg'
        - 'https://github.com/git/git/blob/master/README.md'
    - rule: doi-link-valid
      severity: ignore
      keys:
        - 'https://zenodo.org/**'   # also suppress the DOI validation error

  toc:
    - file: landing-page.md
    - title: Preamble
      children:
        - file: preamble/how-to-use.md
        - file: preamble/how-to-cite.md
    - title: Foundational Skills
      children:
        - file: foundations/overview.md
        - file: foundations/why-python.md
        - file: foundations/getting-started-python.md
          children:
            - file: foundations/quickstart.ipynb
            - file: foundations/how-to-run-python.md
              children:
                - file: foundations/terminal.md
                - file: foundations/jupyter.md
                - file: foundations/conda.md
        - file: foundations/getting-started-jupyter.ipynb
          children:
            - file: foundations/jupyterlab.ipynb
            - file: foundations/markdown.md
        - file: foundations/getting-started-github.md
          children:
            - file: foundations/github/what-is-github.md
            - file: foundations/github/github-repos.md
            - file: foundations/github/github-issues.md
            - file: foundations/github/github-cloning-forking.md
            - file: foundations/github/github-setup-advanced.md
            - file: foundations/github/basic-git.md
            - file: foundations/github/git-branches.md
            - file: foundations/github/github-pull-request.md
            - file: foundations/github/review-pr.md
            - file: foundations/github/git-workflows.md
            - file: foundations/github/contribute-to-pythia.md
    - title: Core Scientific Python Packages
      children:
        - file: core/overview.md
        - file: core/numpy.md
          children:
            - file: core/numpy/numpy-basics.ipynb
            - file: core/numpy/intermediate-numpy.ipynb
            - file: core/numpy/numpy-broadcasting.ipynb
        - file: core/matplotlib.md
          children:
            - file: core/matplotlib/matplotlib-basics.ipynb
            - file: core/matplotlib/histograms-piecharts-animation.ipynb
            - file: core/matplotlib/annotations-colorbars-layouts.ipynb
        - file: core/cartopy.md
          children:
            - file: core/cartopy/cartopy.ipynb
        - file: core/datetime.md
          children:
            - file: core/datetime/datetime.ipynb
        - file: core/pandas.md
          children:
            - file: core/pandas/pandas.ipynb
        - file: core/data-formats.md
          children:
            - file: core/data-formats/netcdf-cf.ipynb
        - file: core/xarray.md
          children:
            - file: core/xarray/xarray-intro.ipynb
            - file: core/xarray/computation-masking.ipynb
            - file: core/xarray/enso-xarray.ipynb
            - file: core/xarray/dask-arrays-xarray.ipynb
    - title: Appendix
      children:
        - file: appendix/glossary.md
        - file: appendix/how-to-contribute.md
          children:
            - file: appendix/template.ipynb

site:
  options:
    analytics_google: G-G57FLM9M46 # Measurement ID or Tracking ID