run_scenario | Run a scenario from a TOML (Tom's Obvious, Minimal Language) definition; returns the summary + full result JSON (JavaScript Object Notation: figures of merit, curves). Optional include_chart returns the chart as SVG (Scalable Vector Graphics). |
list_scenario_kinds | The 93 built-in scenario kinds with descriptions + required/optional fields โ so the agent can construct a valid scenario. |
validate_scenario | Pre-flight check: parse the TOML and detect its kind, without running. |
list_example_scenarios | The bundled reference scenarios as JSON: each name, its kind and one sentence on what it shows. Optional kind filter. Every example runs as it stands, so this is the quickest way to a valid TOML for a kind. |
get_example_scenario | The TOML text of one bundled reference scenario, byte for byte the file under scenarios/. |
report_scenario | Run a scenario and return its report: executive summary, inputs, every figure with its unit and its VALIDATED or MODELLED label, events, the capabilities exercised and a reproducibility record. format is json (default) or html (the printable single-file page). |
animate_scenario | Run a scenario and return its time series as an animation: svg (default), html (a self-contained player) or frames (at most 120 in a reply). The first content item is a JSON summary of what was drawn; the files follow. A kind with no sampled time axis is refused with the reason. |
list_export_formats | Which interoperability formats apply to a scenario (czml, kml, geojson, stk, sigmf), the reason when one does not, and the specification each writer follows. Does not run the scenario. |
export_interop | Export a scenario as CZML (Cesium Language), KML (Keyhole Markup Language), GeoJSON, STK (Systems Tool Kit) ephemeris .e, or SigMF (Signal Metadata Format, for a spectrum scenario with an [iq] block). The first content item is a JSON index of the files (suffix, size, encoding, and the SHA-256 digest, the 256-bit Secure Hash Algorithm); the files follow, the binary SigMF sample file as base64. |
import_route | Write a GeoJSON LineString route into a scenario that flies a waypoint track (terrain-nav, terrain-slam, gravity-map, combined-altpnt) and return the new TOML. |
export_sp3 | Export an orbit scenario's constellation as SP3-c (Standard Product 3, revision c) precise ephemeris. |
export_omm | Export an orbit scenario's elements as a CCSDS (Consultative Committee for Space Data Systems) 502.0-B-2 OMM (Orbit Mean-elements Message) catalogue. |
export_oem | Export an orbit scenario's state series as CCSDS OEM (Orbit Ephemeris Message) 2.0 ephemeris โ the TEME (true equator, mean equinox) position and velocity series flight-dynamics tools (GMAT, the General Mission Analysis Tool; Orekit; STK, the Systems Tool Kit) read; the velocity-carrying complement of the position-only export_sp3. |
export_table_csv | Run a scenario and return its reproducibility table as CSV (comma-separated values) โ the byte-stable table the CLI (command-line interface) writes as <scenario>.table.csv. Only realtime-frame-eop, lunar-time-budget, lunar-jamming, telecom-timing, leo-navmsg (its encode-decode analysis on a kepler16 or kepler-rac message model) and moonlight-service-volume with export_site_lat_deg + export_site_lon_deg set emit one; any other kind returns an error naming these. |
sky_geometry | Sky geometry under an azimuth-dependent skyline: from a site, a time and constellation presets, two-line element sets (tle, propagated by SGP4 to a UTC epoch) or satellites as azimuth/elevation or ECEF, the satellites visible and those hidden by the skyline, GDOP/PDOP/HDOP/VDOP/TDOP from the gnss_lib_py-checked DOP kernel, the east-north-up cofactor and covariance (one clock per system or one in common) and the horizontal error ellipse; with skyline_preset instead of request, a REPRESENTATIVE preset with its provenance and its cut every degree. MODELLED; carries the advisory; no Monte Carlo over MCP. See docs/SKYLINE.md. |
assess_receiver_log | Assess a real GNSS (global navigation satellite system) receiver log for trust. The TOML names the log's format (ubx, rinex, android, sbf, nmea, rtklib-pos, novatel, rtcm3, gnss-sdr, sbp, greis or unicore: every receiver reader of the engine) and gives its bytes inline as text or base64; the tool runs the trust monitors (carrier-to-noise density drop, loss of lock, AGC (automatic gain control), jamming indicator, position jump and, with RINEX plus broadcast navigation, RAIM (receiver autonomous integrity monitoring) and a clock-aided monitor) and returns when and why the fix stopped being trustworthy. Optional [[events]] and [compare] sections score stated events and predicted C/N0 drops against stated tolerances. A [platform] kind = "vessel" table selects the maritime monitors and adds a 0-100 trust score per epoch with the monitors that deducted (advisory; MODELLED). The log goes inline as text or base64 (at most 4 MiB). Chart and per-epoch CSV on request. See docs/RECEIVER-TRUST.md. |
assess_vessel_stream | Score a bounded NMEA 0183 excerpt (at most 2 MiB and 20,000 epochs; it must hold the calibration window) the way kshana receiver-trust live scores it: per-epoch trust state and 0-100 score with the monitors that deducted, a summary and the last $PKSHT. The bounded form of the live command: no socket is opened and nothing is written to a port; the gate, --listen and the telemetry exporters (Prometheus, OTLP, syslog) are command-line only. Advisory only; MODELLED. See docs/MARITIME-TRUST.md. |
assess_vessel_log | A vessel's NMEA 0183 log (at most 4 MiB) as a batch run, with the session TOML stating the vessel's limits: the score model and every epoch's 0-100 score with its deductions (the reply keeps counts by state and the first 200 degraded or untrusted epochs). Advisory only; MODELLED. |
jammertest_import | Read the published Jammertest test catalogue and transmission plan (NPRA/jammertest-plan, MIT) as scheduled truth (kshana jammertest import): one test area's slots become receiver-trust events with the catalogue id and year in each label. Planned slots, not recorded on-air times; no contact field of the plan is read. MODELLED. See docs/JAMMERTEST.md. |
jammertest_score | Score a receiver log against that schedule (kshana jammertest score): per test the detection latency, missed alarms and time to recover, and the false alarms outside every slot. Text logs as log, binary (ubx, sbf) as log_base64. A signed pack needs a key: command line. Advisory only; MODELLED. |
referee_location_score | Score where a monitoring network said interference came from (kshana jammertest locate-score, row B2): per report the attributed event, the geodesic error and region containment and size; per event and pooled, error percentiles, coverage per level, time to first location and time to locate; false locations per hour. Checks arithmetic, not any locator's accuracy. |
create_evidence_pack | A signed evidence pack for a window of a vessel's log (kshana receiver-trust evidence): the raw log bytes for the window, configuration, per-epoch results and reasons, a summary page, and a manifest with every SHA-256 and a hash chain, signed with Ed25519. The signing seed is never returned or logged; without one a one-time key is used, so the pack proves integrity, not identity. A technical record, not a legal opinion. See docs/EVIDENCE-PACKS.md. |
attach_evidence_timestamp | Bind an RFC 3161 timestamp token (base64 of the .tsr bytes) to a pack, in memory (kshana evidence attach-timestamp); the pack with the token must still verify. The timestamp authority's signature is not checked: use openssl ts -verify. |
verify_evidence_pack | Verify a pack (kshana evidence verify): every hash, the chain, the signature, and with the signer's public key and the full log, who signed it and that the slice came from that log. Names every failure and file. The verdict is verified (signer pinned), intact-signer-not-pinned (everything checks but no public key was given, so the signer is not established) or failed; require_timestamp fails a pack with no timestamp token. |
generate_training_nmea | Synthetic bridge NMEA 0183 for crew training from a nmea-scenario TOML (jamming, position drag-off, time spoof, replay delay) with the instructor log (kshana-nmea-training/1); deterministic per seed. Text only: nothing is synthesised at RF or IQ and nothing is transmitted; never for a vessel's live navigation systems. The reply carries the first 2000 lines. |
build_interference_map | A GNSS interference map from ADS-B or AIS position reports as CSV text (at most 4 MiB): one kshana-interference-map/v1 GeoJSON per UTC day, aggregate only (no identifiers, cells under 5 distinct aircraft or vessels withheld), with the dataset licence embedded. A degraded cell does not identify interference as the cause; not a forecast. MODELLED. See docs/INTERFERENCE-MAP.md. |
interference_emitter_regions | Estimated emitter regions from ADS-B or AIS reports as CSV text (at most 4 MiB): regions at stated confidence levels with a centroid and an uncertainty ellipse, never a bare point; aggregate only. A region is not the position of anyone and not a finding of the cause. MODELLED. See docs/INTERFERENCE-MAP.md. |
connect_map | Kshana Connect without code: a kshana.connect/1 mapping and a station (TOML text) applied to a log (text, at most 4 MiB), returning kshana.obs/1 JSON lines identical to kshana connect map. See docs/CONNECT.md. |
export_test_bench | A scenario's vehicle motion and events for a laboratory GNSS simulator (kshana bench-export): motion CSV and JSON, NMEA, waypoints and events as text, nothing written to disk. Kinds gnss-ins, jamming, gnss-sim. No signal: nothing exported is, models or drives a radio-frequency or baseband signal; the simulator and its operator supply the signals. See docs/TEST-BENCH.md. |
create_round_trip_pack | The signed laboratory round-trip pack (kshana evidence round-trip): the scenario, the laboratory's kshana.test-conditions/1 document, the receiver log and its score against the stated events, linked by hash. Refuses conditions and scoring events that disagree. No signal; a technical record, not a certification. |
iq_sweep | Replay one IQ recording in the work directory across several tracking-loop designs (kshana iq sweep): per design and PRN the steady-state phase and code jitter, lock fractions and mean C/N0. At most 256 (design, PRN) channels per call; the span must fit the sample budget. |
iq_monitor | Run the interference and spoofing detection monitors over an IQ recording in the work directory (kshana iq monitor): wideband power and spectral monitors and per-satellite C/N0 and signal-quality monitors against a learned baseline. Series names and lengths and up to 200 events in the reply; the whole report on request as files. An event says a measured quantity left its baseline, not why. MODELLED. |
iq_labfit | Fit the tracking-loop loss-of-lock model to lab runs (kshana iq labfit) from an iq-labfit scenario whose logs are inline (text or base64; a path is refused). Reads and writes no file. MODELLED. |
iq_test_conditions | Validate a kshana.test-conditions/1 file given as text and return the resolved conditions with their hash. Inline only. |
compliance_report | The public-framework mapping filled from result documents given as text (kshana compliance-report): which rows of six resilience frameworks and standards (US DHS Resilient PNT framework v2.0, IMO ships, EASA aviation, NIS2 Article 21, EN 16803, NIST IR 8323r1) the runs support evidence for, which they do not, and each row's gap. Takes runs of {label, result, scenario?} (at most 64, 4 MiB in all). A status says the runs support evidence for the row's capabilities; it is not a finding that a framework is met and not a rating or approval of any product. The statement is returned with every report; show it verbatim. MODELLED. See docs/compliance/. |
compliance_mapping | The static mapping tables (or, with sources, the source documents they cite with versions and URLs) as Markdown, led by the same statement. Needs no runs. |
trust_telemetry | A trust stream (JSON lines) or receiver-trust result rendered as Prometheus text, CEF or LEEF syslog lines, an OTLP JSON payload or Home Assistant MQTT discovery and state lines, with the kshana trust-telemetry encoders. Text in the reply: nothing is sent or served and no clock is read. Advisory only. |
fit_imu_log | Accelerometer and gyro parameters of the hybrid and fusion scenarios fitted from a stationary IMU log (CSV or EuRoC) by Allan deviation, with a ready-to-paste [accel_classical] table and the log's SHA-256 (kshana imu-fit). Text in, JSON out; MODELLED. |
ephem_export | A JPL Horizons state table written as a CCSDS OEM, a CCSDS OPM or an SPK kernel of type 13 or 9, for flight-dynamics tools, and read back state for state (kshana ephem-export). Text in, JSON out (the SPK as base64). |
list_standards_packs | The standards packs (kshana standards-pack list): scored scenario sets for the DHS Resilient PNT framework test profiles (levels 1 to 4), IMO MSC.1/Circ.1575 and ICAO Doc 9849 Appendix F. |
run_standards_pack | One pack run against its bars stated before the run (kshana standards-pack run): each test MET, NOT MET or NEEDS INPUT, with measured and expected values; give the report to compliance_report to see the rows. MODELLED; rates no product. |
lunanet_afs_check | The LunaNet Augmented Forward Signal checked against LNIS V5 AD1 Volume A (LSIS-AFS V1.0, 29 January 2025): spec (the implementation against the document's printed code tables and worked examples), symbols (a symbol stream: sync pattern, SB1, FID, TOI continuity) or generate (a test stream). LDPC and CRC-24Q of subframes 2 to 4 are not verified; no signal is written. |
score_benchmark | A kshana-bench submission scored against a truth file, both JSON text (kshana bench score, bench/SPEC.md): the result file with the spec version, split, input hashes and the task's metrics. MODELLED; describes a log or corpus, never a product. |
render_leaderboard | kshana-bench result files rendered as the static leaderboard page (HTML text), each validated first. |
trust_telemetry | A trust stream (JSON lines) or receiver-trust result rendered as Prometheus text, CEF or LEEF syslog lines or an OTLP JSON payload, with the kshana trust-telemetry encoders. Text in the reply: nothing is sent or served and no clock is read. Advisory only. |
route_exposure | The share of a route's length in degraded, not-degraded, unassessed and not-observed cells of one or more interference maps, optionally within a date range. Unobserved cells are not evidence of a clear route. |
iq_signals | The GNSS IQ layer's set-up: the signal names the IQ tools accept, whether the IQ file tools are on, the work directory and the per-call sample budget. Call it first. |
iq_info | Describe one IQ (in-phase and quadrature) recording in the work directory without processing it: format, sample rate, centre frequency, samples, duration, data files and sizes (kshana iq info). |
iq_scene | Generate a multi-satellite GNSS IQ scene into the work directory (kshana iq scene): stated Doppler/C/N0 profiles, or true broadcast-ephemeris geometry from a RINEX navigation file, with an optional signal-level propagation channel. Replies with the files written and their byte counts and the truth's first epoch per satellite. |
iq_acquire | FFT (fast Fourier transform) acquisition of one or more PRNs (pseudo-random noise codes) over a recording (kshana iq acquire), optionally behind front-end stages: per PRN, acquired or not, Doppler, code phase, peak statistic and threshold; surface_out (one PRN) keeps the whole Doppler ร code-phase correlation surface with fine-Doppler refinements. |
iq_track | Acquire, then track with the DLL/PLL/FLL (delay-, phase- and frequency-locked loop) bank (kshana iq track), with the loops from a kshana.loop-design/1 TOML file in the work directory (design) or the built-in design, and optional re-acquisition (reacquire): per channel, epochs, final Doppler, final and mean C/N0, phase- and code-lock fractions, locked at the end, the final lock state, false locks and re-acquisitions, plus the design's name and hash. Tracking streams in bounded memory; per-epoch output goes to files only (epochs_out: E/P/L, discriminators, loop states, C/N0, lock state as .csv/.jsonl/.bin; events_out). |
iq_frontend | Apply receiver front-end and interference-mitigation DSP (digital signal processing: band-pass, notch, blanking, excision, AGC, quantiser) to a recording and write a new one (kshana iq frontend). |
iq_campaign | Run a lab-replay campaign (kshana iq campaign): recordings, each with a test-condition file stating the lab's known truth, ร front-end chains ร loop designs. Each cell is scored for time to loss of lock, re-acquisition time, C/N0 degradation against the stated J/S (beside an analytic reference labelled MODELLED), false-lock rate, PLL/DLL jitter and availability. Incremental and resumable: each call runs the pending cells that fit the sample budget (or max_cells). |
iq_campaign_status | A campaign output folder's progress: cells done and pending, and the digest once complete. Reads files only. |