docs/mkdocs.yml at master · nyx-space/docs · 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
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
site_name: Nyx Space
site_url: https://nyxspace.com
edit_uri: ""
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.tracking
    - navigation.sections
    - toc.follow
    - content.code.copy
    - content.tabs.link
    - navigation.footer
  logo: assets/logo-icon-inverted.png
  favicon: assets/favicon-256.png
  font:
    text: Montserrat
    code: Inconsolata
  palette:
    scheme: default
    primary: custom

  icon:
    admonition:
      tip: material/rocket-launch-outline

nav:
  - Home: index.md
  - Nyx:
      - Showcase:
          - Showcase home: nyxspace/showcase/index.md
          - High fidelity orbit propagation: nyxspace/showcase/01_orbit_prop/index.md
          - James Webb Space Telescope Monte Carlo: nyxspace/showcase/02_jwst_covar_monte_carlo/index.md
          - GEO low thrust orbit raising: nyxspace/showcase/03_geo_analysis/index.md
          - Orbit Determination of the Lunar Reconnaissance Orbiter (LRO): nyxspace/showcase/04_lro_od/index.md
          # - Mission design:
          #     - Table of contents: nyxspace/showcase/mission_design/index.md
          #     # - Lunar transfer [WIP]: nyxspace/showcase/mission_design/lunar_transfer.md
          #     - Orbit design from a genetic algorithm: nyxspace/showcase/mission_design/orbit_design_ga.md
          # - Constellation analysis [WIP]: nyxspace/showcase/constellation_analysis/index.md
          # - Spacecraft navigation:
          #     - Ground based navigation [WIP]: nyxspace/showcase/spacecraft_navigation/ground_nav.md
          # - CAPS [WIP]: nyxspace/showcase/spacecraft_navigation/CAPS.md
      # - User guide:
      #     - Getting started [WIP]: nyxspace/user_guide/start.md
      #     - Orbit definition and manipulation [WIP]: nyxspace/user_guide/orbits.md
      #     - Propagators and Monte Carlo runs [WIP]: nyxspace/user_guide/prop-mc.md
      #     - High fidelity models [WIP]: nyxspace/user_guide/hifimodels.md
      - MathSpec:
          - Introduction: nyxspace/MathSpec/index.md
          - Celestial:
              - Coordinate frames: nyxspace/MathSpec/celestial/coord_systems.md
              - Orbital elements: nyxspace/MathSpec/celestial/orbital_elements.md
              - Trajectory interpolation: nyxspace/MathSpec/celestial/interpolation.md
              - Eclipses: nyxspace/MathSpec/celestial/eclipse.md
          - Dynamical Models:
              - Overview: nyxspace/MathSpec/models/overview.md
              - Gravity: nyxspace/MathSpec/models/gravity.md
              - Spherical harmonics: nyxspace/MathSpec/models/harmonics.md
              - Solar radiation pressure: nyxspace/MathSpec/models/srp.md
              # - Drag [WIP]: nyxspace/MathSpec/models/drag.md
              # - Control laws [WIP]: nyxspace/MathSpec/models/control_laws.md
              # - Finite burns [WIP]: nyxspace/MathSpec/models/finite_burns.md
          - Orbit determination:
              - Overview: nyxspace/MathSpec/orbit_determination/overview.md
              - Kalman filter: nyxspace/MathSpec/orbit_determination/kalman.md
              - State noise compensation: nyxspace/MathSpec/orbit_determination/snc.md
              - Smoothing: nyxspace/MathSpec/orbit_determination/smoothing.md
              - Iteration: nyxspace/MathSpec/orbit_determination/iteration.md
              - Measurement generation: nyxspace/MathSpec/orbit_determination/measurements.md
          - Monte Carlo:
              - Overview: nyxspace/MathSpec/monte_carlo/overview.md
              - Error modeling: nyxspace/MathSpec/monte_carlo/error_models.md
          - Optimization:
              - State transition matrix (STM): nyxspace/MathSpec/optimization/stm.md
              - Targeting: nyxspace/MathSpec/optimization/targeting.md
          - Propagators: nyxspace/MathSpec/propagators.md
          - Appendices:
              - Dual numbers: nyxspace/MathSpec/appendix/dual_numbers.md
      - Versions: versions.md

  - Hifitime:
      - Hifitime: hifitime/index.md
      - Design: hifitime/design.md
      - Python user guide: hifitime/python.md
      - Rust user guide: hifitime/rust.md
      - Change Log: hifitime/changelog.md

  - ANISE:
      - ANISE: anise/index.md
      - Tutorials:
          - Tutorials index: anise/tutorials/index.md
          - Querying SPK files: anise/tutorials/Tutorial 01 - Querying SPK files.ipynb
          - Loading remote data: anise/tutorials/Tutorial 02 - Loading remote SPICE and ANISE files (meta almanac).ipynb
          - Working with Orbit class: anise/tutorials/Tutorial 03 - Defining and working with the Orbit structure.ipynb
          - Azimuth, Elevation, Range (AER): anise/tutorials/Tutorial 04 - Computing Azimuth Elevation and Range data.ipynb
          - Planetary constant kernels (PCK): anise/tutorials/Tutorial 05 - Using frame kernels and text planetary kernels.ipynb
          - Custom Plantary and Euler Parameter (Quaternion) Kernels (PCK & EPA): anise/tutorials/Tutorial 05 - Using frame kernels and text planetary kernels.ipynb
          - Sun Probe Earth angle (SPE): anise/tutorials/Tutorial 06 - Sun probe Earth angle.ipynb
          - Analysis engine: anise/tutorials/Tutorial 07 - Analysis.ipynb
          - OEM and Covariance: anise/tutorials/Tutorial 08 - OEM and Covariance.ipynb
      - Explanation:
          - Explanation index: anise/explanation/index.md
          - Why ANISE?: anise/explanation/why-anise.md
          - Almanac: anise/explanation/almanac-and-context.md
          - Frame Safety: anise/explanation/frame-safety.md
          - Time management: anise/explanation/time.md
          - Analysis Engine: anise/explanation/analysis.md
          - Validation: anise/explanation/validation.md
      - Reference:
          - Reference index: anise/reference/index.md
          - Almanac: anise/reference/almanac.md
          - Frame: anise/reference/frame.md
          - Orbit and States: anise/reference/orbit.md
          - Analysis API: anise/reference/analysis-api.md
          - Azimuth, Elevation, Range: anise/reference/azimuth-elevation-range.md
          - Location Kernels: anise/reference/location.md
          - Instrument Kernels: anise/reference/instrument.md
          - API Documentation: anise/reference/api/index.md
          - Math Spec:
              - Orbital elements: anise/reference/mathspec/orbital_elements.md
              - Interpolation methods:
                - Interpolation index: anise/reference/mathspec/interpolation/index.md
                - Covariance interpolation: anise/reference/mathspec/interpolation/covariance.md
                - Chebyshev interpolation: anise/reference/mathspec/interpolation/chebyshev.md
                - Hermite interpolation: anise/reference/mathspec/interpolation/hermite.md
                - Lagrange interpolation: anise/reference/mathspec/interpolation/lagrange.md
          - Python API:
              - ANISE Python: anise/reference/api/python/index.md
              - Astro: anise/reference/api/python/astro.md
              - Constants: anise/reference/api/python/constants.md
              - Time: anise/reference/api/python/time.md
              - Utils: anise/reference/api/python/utils.md
          - Rust API: anise/reference/api/rust/index.md

  - Pricing: pricing.md
  - Blog:
      - blog/index.md

extra_css:
  - stylesheets/extras.css

plugins:
  - search
  - mkdocs-jupyter:
      ignore_h1_titles: True
  - blog
  - glightbox
  - redirects:
      redirect_maps:
        "hifitime/intro.md": "hifitime/index.md"
        "anise/intro.md": "anise/index.md"
        "nyxspace/MathSpec/celestial/orbital_elements.md": "anise/reference/mathspec/orbital_elements.md"
        "nyxspace/MathSpec/celestial/interpolation.md": "anise/reference/mathspec/interpolation/index.md"

copyright: Copyright &copy; 2024 - Christopher Rabotin

repo_url: https://github.com/nyx-space/nyx
repo_name: nyx-space/nyx

extra:
  social:
    - icon: material/comment-multiple
      link: https://app.element.io/#/room/#astrodyn:matrix.org
      name: Astrodynamics on Matrix.org
    - icon: material/linkedin
      link: https://www.linkedin.com/in/chrisrabotin/
      name: Chris Rabotin on LinkedIn
    - icon: material/twitter
      link: https://twitter.com/CRabotin
      name: Chris Rabotin on Twitter
    - icon: material/email-outline
      link: mailto:christopher.rabotin@gmail.com
      name: Email me
  analytics:
    provider: google
    property: G-9Y2KY15FW5

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - abbr
  - attr_list
  - md_in_html
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.tabbed
  - footnotes
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true

extra_javascript:
  - js/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js