Kshana documentation
Everything here is rendered at build time from Markdown files tracked in the Kshana repository (engine v0.41.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.
- GlossaryPlain-language definitions of the terms used in Kshana.
- LanguagesThe engine's human-facing text is in 17 languages beside English: nl, pl, pt-BR, pt-PT, fi, sv, da, nb, cs…
- 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 93 built-in scenario kinds that kshana::api::run_toml dispatches over, each with its one-line…
- Every scenario kind, by familyEvery scenario kind the engine v0.41.0 dispatches (93), filed under 14 families.
- Every commandkshana <scenario.toml> runs a scenario; every other command is a subcommand. kshana --help prints the usage…
- Every surfaceOne engine, the same results everywhere. docs/SURFACES.md lists, for every command and kind, which surface…
- Capability domainsEvery capability of the public map, by domain, with its ledger label.
- Scenario referenceEvery bundled scenario file (195), 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…
- Flight-dynamics export: OEM, OPM and SPKThis is step 1 of roadmap item C7 (adapters and notebooks for flight-dynamics tools; pre-registration).
- Flight-dynamics tools reading Kshana's filesRoadmap item C7. Kshana writes a trajectory as a CCSDS OEM, a CCSDS OPM or a SPICE SPK kernel (kshana…
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: 413 rows — 176 VALIDATED, 233 MODELLED, 4 PARTNER.
- Capability referenceThe capability cards and all 413 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 "~95 % line coverage" on the README badge, the README CI (continuous integration) table, the crates.io…
- Evidence packsA pack is a technical record, not a legal opinion.
- Data partners and promoting rowsKshana labels every capability in a machine-checked ledger (verification matrix).
Timing
- Optical links through the atmosphereThe optical-atmosphere scenario kind answers how often an optical link to the ground works, why it fails…
- 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…
- Holdover test and timing hardware in the loopTelecom and power operators test a timing system by taking its GNSS away and watching what the clock does.
- Clock log formatssrc/clock_log.rs reads a measured clock log into one normalised phase series: a uniform grid of (time_s…
- Hardware safetyKshana is advisory software for research, simulation and test.
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 rated or approved. This maps Kshana's simulated capabilities to the published PNT-resilience…
Receiver trust and maritime
- Receiver trustkshana receiver-trust reads a log from a real global navigation satellite system (GNSS) receiver, runs trust…
- Maritime trustkshana receiver-trust can score, for a moving vessel, a live 0-100 trust figure for every position fix, from…
- NMEA training streamsMaritime academies and simulator centres can feed Kshana-generated NMEA 0183 into a bridge simulator or a…
- Interference map and route exposurekshana interference-map builds a per-day picture of where aircraft and ships reported degraded navigation…
- Interference map: data sources and licencesOutputs of Kshana never contain per-aircraft or per-vessel identifiers (ICAO hex, MMSI, callsign, name).
- Marine integrationsKshana's maritime trust score (MARITIME-TRUST.md) is reachable from software boaters already run: a Signal K…
- Sky geometry and skylinesUntil 0.36 every Earth visibility test in the engine was one elevation cut-off, mask_deg: a satellite…
- Trust as security telemetrykshana trust-telemetry turns the per-epoch GNSS trust stream (score 0-100, band, reasons) into signals an…
- Galileo OSNMA verificationA receiver-side verifier for Galileo Open Service Navigation Message Authentication (OSNMA), in pure Rust.
- LunaNet augmented forward signalKshana implements the spreading codes and the message layer of the LunaNet Augmented Forward Signal (AFS) as…
- Jammertest as a refereekshana jammertest import reads the Jammertest test catalogue and transmission plan and turns one test area's…
- Machine and sensor inputsReaders that bring other receivers, solvers and sensors into the receiver-trust kind.
- Receiver protocols readRead only, throughout: nothing here writes a byte to a receiver, and there is no transmit path of any kind.
- Kshana StationA Kshana Station is a computer on a site wired to receivers. kshana station run reads each receiver's stream…
- Kshana Connect: mapping filesA mapping file (kshana.connect/1, TOML) tells Kshana how to read an export it has no reader for, and turns…
- Adapter registryAn adapter teaches Kshana to read a device's or a logger's export, by configuration only.
- Interference observatory: methodOne product per UTC day and region, from one open aircraft-position archive.
- Interference observatory: resultsExample of what a day reads: on 2026-09-15 the archive held 110,619,797 position rows in 79,826 trace files…
- kshana-benchAn open set of tasks, splits and metrics for GNSS interference detection and timing holdover.
Compliance and test bench
- Running a receiver against a scenarioA receiver maker who owns a laboratory GNSS simulator can replay a Kshana scenario's vehicle motion through…
- Compliance mappingBuyers and receiver makers answer to public resilience frameworks.
- US DHS resilient PNT frameworkThe framework describes resilience levels 0 to 4 built from eight numbered requirements, and an evaluation…
- IMO guidance for shipsIMO's GNSS-interference text for ships is thin: MSC.1/Circ.1644 is addressed mainly to Member States, and…
- EASA guidance for aviationEASA's Safety Information Bulletin is informational, not mandatory, and addressed to authorities, air…
- EU NIS2, Article 21Article 21 lists, in paragraph 2 points (a) to (j), the measures essential and important entities take to…
- EN 16803EN 16803 is a paid standard. Only its part structure and the clause numbers visible in public catalogue…
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…
- Lunar reference stationMODELLED. Under the stated assumptions (the constellation, its signal-in-space error, the station's survey…
- Space-user navigation (gnss-ssv)Advisory only. Modelled results from stated inputs and a simulated truth; not a certification, a…
- Lunar orbit and surface as infrastructureThe designs, inputs and bars were fixed in xval/lunar-infra/PREREGISTRATION.md (committed before any study…
- Mission thread: launch to entryAdvisory software, not certified navigation equipment.
- Mission thread: the lunar segmentFour scenario kinds, each also a phase kind of the mission-thread interface (src/mission_thread/): they…
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…
- MCP server: every install channelAdvisory, not type-approved navigation equipment: the operator remains responsible for navigation.
- MCP server: self-hosted HTTP modeKshana does not host an endpoint. There is no shared kshana server to point a client at.
- Using Kshana from an agentFor an agent (or the person directing one): which tool to call for which question, what the tools will and…
- Where each capability is reachableEvery capability is available on the surfaces where it makes sense; where one cannot carry a capability, the…
- 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
- ChangelogAll notable changes to Kshana are documented here.
- 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…
Scenario kind families
- Campaigns1 scenario kind of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Clocks timing and holdover9 scenario kinds of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Constellations coverage and geometry7 scenario kinds of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Gnss measurements positioning and integrity6 scenario kinds of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Gps denied alternative pnt5 scenario kinds of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Inertial fusion and quantum sensors9 scenario kinds of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Jamming spoofing and the spectrum6 scenario kinds of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Low earth orbit navigation7 scenario kinds of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Lunar and cislunar24 scenario kinds of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Mission analysis links and space operations14 scenario kinds of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Mission threads1 scenario kind of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Optical pnt2 scenario kinds of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Space rf survey1 scenario kind of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
- Space user navigation1 scenario kind of the engine v0.41.0. Advisory: analysis output from a research and engineering tool, not…
Scenario kind pages
93 pages, one for each scenario kind, linked from Every scenario kind, by family.
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).