Kshana documentation
Everything here is rendered at build time from Markdown files tracked in the Kshana repository (engine v0.29.0), plus two reference pages generated from the scenario files and the verification matrix. Nothing is written by hand for the site.
Get started
- OverviewKshana replays jamming, spoofing and clock holdover when GNSS (Global Navigation Satellite System) signals…
- Concepts primerThis page explains what Kshana does and why, starting from zero and building up to the physics.
- Studio guideKshana Studio: run the engine in your browser, no install.
- TutorialsHands-on, worked examples that take you from “run a shipped scenario” to “quantify and defend a result.”…
- 1 · Your first orbitBy the end you will have propagated the real operational GPS constellation, read its availability and…
- 2 · Clock holdoverBy the end you will have run a clock holdover with GNSS (Global Navigation Satellite System) signals denied…
- 3 · Quantum against classicalThe capstone. You will run a spoofing-detector scenario and a full fused positioning, navigation and timing…
- Worked example: multi-tool pipelineThis walks one trajectory through the standards-based interop and mission-analysis scenario kinds end to…
Scenarios
- Scenario kindsThe 75 built-in scenario kinds that kshana::api::run_toml dispatches over, each with its one-line…
- Scenario referenceEvery bundled scenario file (138), grouped by kind, with its key settings.
- Result schemaEvery run writes a versioned, self-describing JSON (JavaScript Object Notation) artifact next to the scenario.
- Using real TLEsThe bundled scenarios/orbit-sgp4-gps.toml already carries real TLEs (two-line element sets): the Celestrak…
- CampaignsA single scenario answers one question about one situation.
Outputs and exports
- Run reportsEvery run of the command-line interface (CLI) writes a report beside its result: a printable HyperText…
- Animation export--animate turns a run's time series into something that moves: an animated Scalable Vector Graphics (SVG)…
- Interoperability exports and importsA run writes a result document, a chart and a report. --export also writes the scenario's geometry, or its…
Validation and evidence
- Validation statusOn tolerances. "Validated" below means a calibration test asserts the simulated statistic matches the…
- Verification matrixThe complete, machine-checked evidence ledger: 223 rows — 83 VALIDATED, 136 MODELLED, 4 PARTNER.
- Capability referenceThe capability cards and all 223 rows of the verification matrix.
- Why rows stay ModelledThese capabilities are implemented from published or first-principles physics with tests, but are honestly…
- Claims against realityAn independent audit of an earlier Kshana version catalogued fourteen overclaims (OC-0…OC-13): places where…
- ProvenanceKshana's central honesty discipline is that every sensor parameter, physical model, and validation dataset…
- ReproducibilityKshana is built to be reproducible: the same inputs produce the same results, and the build artifacts can be…
- Capability mapKshana is a PNT (positioning, navigation and timing) performance-and-resilience evidence engine, not a full…
- Standards and interoperabilityKshana speaks the standard interchange formats of the GNSS (global navigation satellite system)…
- Line coverageThe "~96 % line coverage" on the README badge, the README CI (continuous integration) table, the crates.io…
Timing
- Slot timingThe slot-timing scenario kind answers three questions for a clock that free-runs between synchronisations…
- Telecom timingThis page lists every limit the telecom-timing scenario kind checks, where each one comes from, and what was…
- Deceived timeA technical note for operators of time-indexed networks: constellations that route, task or hand over by a…
Integrity and interference
- Integrity and securityKshana reports two figures of merit (FoMs) — Integrity and Security — that are easy to mistake for the…
- Spectrum and waterfallThe spectrum scenario kind builds the Global Navigation Satellite System (GNSS) L band, and any other band a…
- ARAIM referenceThis note documents Kshana's open implementation of Advanced Receiver Autonomous Integrity Monitoring…
- DO-316 / DO-229E mapThis document maps the RTCA (formerly the Radio Technical Commission for Aeronautics) DO-229E (SBAS…
- Resilience cross-walkAligned to, not certified. This maps Kshana's simulated capabilities to the published PNT-resilience (PNT…
Orbits
- SGP4 validationKshana's orbit propagator is validated against the canonical community reference for SGP4/SDP4 (SGP4…
- Force-model validationKshana's full-force engine (src/precise_od.rs) fit to real agency precise-orbit products, with honest…
- Solar system and other bodiesThe constellation-design kind uses the same catalogue to build constellations around any of these bodies…
Low Earth orbit (LEO) navigation
- LEO positioning, navigation and timingLEO-PNT is positioning, navigation and timing (PNT) from satellites in low Earth orbit (LEO), alongside or…
- LEO signal designsThe leo-signal scenario kind analyses low Earth orbit (LEO) positioning, navigation and timing (PNT) signals.
- LEO pass and link budgetLEO-PNT is positioning, navigation and timing (PNT) from satellites in low Earth orbit (LEO).
- LEO navigation messageThe leo-navmsg scenario kind builds the broadcast ephemeris and clock message of a low Earth orbit (LEO)…
- Fused MEO and LEO positioningThree scenario kinds provide positioning, navigation and timing (PNT) with satellites in low Earth orbit…
- Constellation designThe constellation-design kind builds one or more satellite constellations around the Earth, the Moon, Mars…
Quantum sensors
- Quantum-sensor modelsKshana is a PNT-resilience (PNT: positioning, navigation and timing) simulator with quantum-sensor…
- Cold-atom interferometerMost of Kshana drives its quantum sensors from published Allan/noise coefficients — datasheet lookups (see…
APIs and integrations
- Python APIKshana ships a first-class Python application programming interface (API), built with PyO3 and maturin.
- npm and WebAssemblyKshana replays jamming, spoofing and clock holdover when GNSS (Global Navigation Satellite System) signals…
- Rust crateKshana replays jamming, spoofing and clock holdover when GNSS (Global Navigation Satellite System) signals…
- MCP serverkshana-mcp is a Model Context Protocol (MCP) server for Kshana, the open-source simulator for PNT…
- JetBrains pluginA native plugin that runs the Kshana PNT-resilience simulator from inside any JetBrains IDE (IntelliJ IDEA…
- Where Kshana runsA scope boundary, written down so that nobody discovers it as a commitment in a meeting.
- ArchitectureKshana is one engine organised in layers over a shared core: the sensor packs (clock, inertial…
- Where Kshana sitsKshana is an open, reproducible PNT (positioning, navigation and timing) resilience evidence engine.
Project
- GlossaryPlain-language definitions of the terms used in Kshana.
- ChangelogAll notable changes to Kshana are documented here.
- RoadmapThis is the phased, honest roadmap for Kshana. It complements two other sources of truth: CHANGELOG.md…
- LicensingKshana is dual-licensed. You may use the open engine under either the open licence (AGPL-3.0) or a…
- SecurityPlease do not open a public issue for security-sensitive reports.
- ContributingThanks for your interest. Kshana aims to be a neutral, reproducible, honestly- validated reference for…
- GovernanceThis document states how Kshana is governed: who makes decisions, how, and what the project will and will…
- Code of conductWe as members, contributors, and leaders pledge to make participation in our community a harassment-free…
Not included
Maintainer-process documents stay in the repository: docs/RELEASING.md (release procedure); docs/WHEEL_TAGS.md (packaging detail); docs/revisions/ (internal change notes); docs/design/ (internal design notes); README.pypi.md (the PyPI page; the Python API doc covers it); .github/ templates; docs/integrations.md (organised around named third-party AI products, which this site does not name).