site_name: tetra3rs
site_description: Fast, robust lost-in-space star plate solver written in Rust
site_url: https://ssmichael1.github.io/tetra3rs/
repo_url: https://github.com/ssmichael1/tetra3rs
repo_name: ssmichael1/tetra3rs
theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.code.copy
- navigation.instant
- navigation.sections
- navigation.expand
- navigation.top
- search.highlight
- search.suggest
- toc.follow
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.tabbed:
alternate_style: true
- pymdownx.arithmatex:
generic: true
- attr_list
- md_in_html
- toc:
permalink: true
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/mathjax.js
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [python]
options:
allow_inspection: false
show_source: false
show_bases: false
members_order: source
docstring_style: google
show_root_heading: true
show_root_full_path: false
heading_level: 2
- mkdocs-jupyter:
execute: true
kernel_name: python3
include_source: true
nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- Quick Start: getting-started/quickstart.md
- Concepts:
- Algorithm Overview: concepts/algorithm.md
- Centroid Extraction: concepts/centroid-extraction.md
- Coordinate Conventions: concepts/coordinates.md
- Camera Model: concepts/camera-model.md
- WCS Output: concepts/wcs.md
- Stellar Aberration: concepts/aberration.md
- Tutorials:
- tutorials/index.md
- Basic Plate Solving: tutorials/basic-solve.ipynb
- Multi-Image Calibration: tutorials/multi-image-calibration.ipynb
- API Reference:
- Overview: api/index.md
- SolverDatabase: api/solver-database.md
- CameraModel: api/camera-model.md
- SolveResult: api/solve-result.md
- CalibrateResult: api/calibrate-result.md
- Centroid Extraction: api/extraction.md
- Distortion Models: api/distortion.md
- Functions: api/functions.md