API Python

O Kshana distribui uma interface de programação de aplicações (API) Python de primeira classe, construída com PyO3 e maturin. Suas wheels abi3 são compiladas contra a interface binária de aplicação (ABI) estável do Python, de modo que uma wheel por plataforma funciona em todo CPython ≥ 3,9; as wheels cobrem Linux, macOS e Windows, cada um em x86-64 e ARM de 64 bits (consulte WHEEL_TAGS.md). Um stub de tipos incluído (kshana.pyi + py.typed) dá a editores e a mypy/pyright informações de tipo completas.

pip install kshana            # from the Python Package Index, PyPI (release wheels)
# or, from a checkout:
pip install maturin && maturin develop --features python

Início rápido#

Execute estes trechos a partir da raiz de um checkout do repositório: eles leem arquivos de cenário em scenarios/. A linha do NumPy precisa de pip install numpy.

import kshana

toml = open("scenarios/clock-holdover.toml").read()

# Typed result with a parsed-dict accessor:
out = kshana.run_typed(toml)
print(out.summary)
data = out.data()                         # a Python dict — no JSON re-parsing
fom = data["quantum"]["fom"]              # figures of merit, quantum side
classical_fom = data["classical"]["fom"]  # … and the classical baseline
print(out.json[:80], "...")               # raw JSON also available
open("chart.svg", "w").write(out.svg)     # the chart SVG

# NumPy arrays straight from the result (NumPy is imported on call; it is not a
# dependency of the package):
curve = out.columns("quantum.adev_curve")  # {"tau_s": ndarray, "adev": ndarray, ...}
adev = curve["adev"]
everything = out.series()                  # every record series, keyed by path

Superfície#

Assinaturas de IQ GNSS e de confiança do receptor#

As assinaturas completas, como kshana.pyi as declara (toda palavra-chave após os argumentos obrigatórios tem um valor padrão; as docstrings no stub dão o significado de cada uma). Envolva as listas samples_i / samples_q, e as entradas i / q, com numpy.asarray(...) para obter matrizes.

def receiver_trust(toml: str) -> RunOutput: ...

def receiver_trust_replay(session_toml: str, nmea: str | bytes) -> dict: ...
def assess_vessel_log(session_toml: str, log: str | bytes) -> dict: ...
def jammertest_import(catalog_json: str, plans: list[str], log_start_utc: str, location: int | None = None,
                      local_offset_h: float = 2.0, year: int | None = None) -> dict: ...
def jammertest_score(session_toml: str, log: str | bytes, catalog_json: str, plans: list[str],
                     location: int | None = None, local_offset_h: float = 2.0,
                     log_start_utc: str | None = None, year: int | None = None,
                     recover_hold_s: float = 10.0, guard_s: float = 60.0) -> dict: ...
def evidence_create(session_toml: str, log: str | bytes, from_s: float, to_s: float,
                    title: str | None = None, created_utc: str | None = None,
                    seed_hex: str | None = None) -> dict: ...
def evidence_verify(files: dict[str, str | bytes], public_key: str | None = None,
                    full_log: str | bytes | None = None,
                    require_timestamp: bool = False) -> dict: ...
def interference_map(source: str, csv: str, dataset: str, cell_deg: float | None = None,
                     licence: str | None = None, licence_url: str | None = None,
                     attribution: str | None = None, land_geojson: str | None = None) -> list[dict]: ...
def route_exposure(route: str, maps: list[str], date_from: str | None = None,
                   date_to: str | None = None) -> str: ...
def export_sp3(toml: str) -> str: ...
def export_omm(toml: str) -> str: ...
def export_oem(toml: str) -> str: ...
def export_formats(toml: str) -> list[dict]: ...
def export_scenario(toml: str, format: str) -> dict: ...
def import_route(toml: str, geojson: str) -> str: ...
def animate_scenario(toml: str, format: str = "svg", fps: int | None = None,
                     duration_s: float | None = None, width: int | None = None) -> dict: ...
def list_examples(kind: str | None = None) -> dict: ...
def get_example(name: str) -> str: ...
def evidence_attach_timestamp(files: dict[str, str | bytes], token: str | bytes,
                              replace: bool = False) -> dict: ...
def evidence_keygen() -> dict: ...
def iq_sweep(i: list[float], q: list[float], fs_hz: float, signal: str, prns: list[int],
             **options) -> dict: ...
def iq_info(path: str, hash: bool = False) -> dict: ...
def iq_inventory(directory: str, recursive: bool = False, hash: bool = False) -> list[dict]: ...
def bench_export(toml: str, epoch: str | None = None) -> dict: ...
def compliance_report(runs: list[dict[str, str]]) -> dict: ...
def compliance_mapping(sources: bool = False) -> str: ...
def standards_pack_list() -> dict[str, Any]: ...
def standards_pack_run(pack_id: str) -> dict[str, Any]: ...
def lunanet_afs_check_spec() -> dict[str, Any]: ...
def lunanet_afs_check_symbols(symbols: str, max_sp_errors: int = 0) -> dict[str, Any]: ...
def lunanet_afs_generate(frames: int = 1, toi0: int = 0) -> str: ...
def evidence_round_trip(scoring_toml: str, scenario_toml: str, conditions: str, log: str | bytes, from_s: float, to_s: float, title: Optional[str] = None, created_utc: Optional[str] = None, seed_hex: Optional[str] = None) -> dict[str, Any]: ...
def bench_score(truth_json: str, predictions_json: str, threshold: float | None = None) -> str: ...
def bench_leaderboard(results: list[str]) -> str: ...
def osnma_verify(data: bytes | str, format: str = "", start_gst: int | None = None,
                 merkle_root_hex: str = "", public_keys: list[str] | None = None,
                 reference_time: int | None = None, max_time_error: int | None = None) -> dict: ...
def sky_geometry(request: str | dict[str, Any]) -> dict[str, Any]: ...
def sky_monte_carlo(request: str | dict[str, Any], seed: int = 0, n: int = 1000) -> dict[str, Any]: ...
def skyline_presets() -> list[dict[str, Any]]: ...
def skyline_profile(skyline: str | dict[str, Any]) -> dict[str, Any]: ...
def skyplot_svg(request: str | dict[str, Any]) -> str: ...
def trust_telemetry(input: str, format: str, host: str = "", input_kind: str = "jsonl",
                    expose_position: bool = False, syslog_all: bool = False,
                    unix_nano: int = 0) -> str: ...
def nmea_training(toml: str, seed: int | None = None) -> dict[str, str]: ...

def iq_signals() -> list[str]: ...

def iq_scene(
    fs_hz: float,
    duration_s: float,
    signal: str,
    prns: list[int],
    dopplers: Optional[list[float]] = ...,
    cn0_dbhz: Optional[float] = ...,
    center_hz: Optional[float] = ...,
    if_hz: float = ...,
    noise: bool = ...,
    noise_figure_db: float = ...,
    seed: int = ...,
    data: bool = ...,
    threads: int = ...,
    iono_stec: Optional[float] = ...,
    iono_vtec: Optional[float] = ...,
    iono_klobuchar: bool = ...,
    tropo: bool = ...,
    tropo_doy: float = ...,
    s4: Optional[float] = ...,
    scint_tau0: float = ...,
    sigma_phi: float = ...,
    multipath_height: Optional[float] = ...,
    multipath_ground: str = ...,
    land_mobile: bool = ...,
    nlos: bool = ...,
) -> dict[str, Any]: ...

def iq_scene_broadcast(
    fs_hz: float,
    window_s: float,
    nav_text: str,
    rx_lat: float,
    rx_lon: float,
    rx_alt: float,
    prns: Optional[list[int]] = ...,
    start_tow: float = ...,
    cn0_dbhz: Optional[float] = ...,
    center_hz: Optional[float] = ...,
    if_hz: float = ...,
    noise: bool = ...,
    noise_figure_db: float = ...,
    seed: int = ...,
    mask_deg: float = ...,
    threads: int = ...,
) -> dict[str, Any]: ...

def iq_acquire(
    i: list[float],
    q: list[float],
    fs_hz: float,
    signal: str,
    prns: list[int],
    if_hz: float = ...,
    center_hz: Optional[float] = ...,
    coherent: int = ...,
    noncoherent: int = ...,
    doppler_max: float = ...,
    doppler_step: Optional[float] = ...,
    pfa: float = ...,
) -> list[dict[str, Any]]: ...

def iq_acq_surface(
    i: list[float],
    q: list[float],
    fs_hz: float,
    signal: str,
    prn: int,
    if_hz: float = ...,
    center_hz: Optional[float] = ...,
    coherent: int = ...,
    noncoherent: int = ...,
    doppler_max: float = ...,
    doppler_step: Optional[float] = ...,
    pfa: float = ...,
) -> dict[str, Any]: ...

def iq_track(
    i: list[float],
    q: list[float],
    fs_hz: float,
    signal: str,
    prns: list[int],
    if_hz: float = ...,
    center_hz: Optional[float] = ...,
    pll_bw: Optional[float] = ...,
    fll_bw: Optional[float] = ...,
    dll_bw: Optional[float] = ...,
    spacing: Optional[float] = ...,
    coherent: Optional[int] = ...,
    periods_per_bit: Optional[int] = ...,
    acq_coherent: Optional[int] = ...,
    acq_noncoherent: int = ...,
    doppler_max: float = ...,
    max_seconds: Optional[float] = ...,
) -> dict[str, Any]: ...

def iq_frontend(
    i: list[float],
    q: list[float],
    fs_hz: float,
    bandpass_lo: Optional[float] = ...,
    bandpass_hi: Optional[float] = ...,
    bandpass_transition: Optional[float] = ...,
    bandpass_atten: float = ...,
    notch: bool = ...,
    notch_r: float = ...,
    notch_mu: float = ...,
    blank: Optional[float] = ...,
    blank_hold: int = ...,
    excise: bool = ...,
    excise_fft: int = ...,
    excise_pfa: float = ...,
    agc: bool = ...,
    agc_tau: float = ...,
    bits: Optional[int] = ...,
    quant_step: Optional[float] = ...,
    no_agc: bool = ...,
) -> dict[str, Any]: ...

def iq_labfit(toml: str) -> dict[str, Any]: ...
def iq_loop_designs(toml: str) -> list[dict[str, Any]]: ...
def iq_read_epochs(path: str) -> dict[str, Any]: ...
def iq_monitor(path: str, signal: Optional[str] = ..., prns: Optional[list[int]] = ...,
               power: bool = ..., spectral: bool = ..., settings: Optional[str] = ...,
               **options) -> dict[str, Any]: ...
def iq_test_conditions(conditions: str) -> dict[str, Any]: ...
def iq_campaign(campaign: str, out_dir: str, workers: int = 0, resume: bool = True,
                max_cells: Optional[int] = None, dry_run: bool = False) -> dict[str, Any]: ...
def iq_campaign_report(out_dir: str) -> dict[str, Any]: ...

Uma campanha de replay em laboratório a partir de Python e depois o seu relatório (o arquivo da campanha e suas gravações são seus; uma célula concluída é pulada na chamada seguinte; iq_read_epochs lê um arquivo de épocas de rastreamento que uma execução de kshana iq track --epochs gravou):

import kshana

summary = kshana.iq_campaign("lab.campaign.toml", "campaign-out", workers=4)
report = kshana.iq_campaign_report("campaign-out")
print(report["digest"])          # None until every cell is done

O acq_coherent de iq_track define quantos períodos de código a aquisição de transferência integra de forma coerente. A partir da 0.33.0 o padrão é None, que significa automático: cerca de 4 ms (4 períodos para um código de 1 ms como o GPS L1 C/A, 1 para um código de 4 ms ou mais longo), de modo que o canal comece perto o bastante para a malha de frequência fazer a captura; acq_coherent=1 mantém a busca de um período da 0,32.

Tipos#

kshana.pyi tipa os vocabulários fechados para verificadores (mypy, pyright): ScenarioKind (o nome de cada tipo de cenário, um Literal), ErrorKind (as quatro etiquetas que error_kind devolve), ProvenanceClass, e os TypedDicts KindMeta (do que scenario_kinds() devolve uma lista) e FieldUnit (uma entrada do bloco units de um resultado, que estende a base de chaves obrigatórias _FieldUnitBase). Eles existem apenas para verificadores de tipos e não podem ser importados em tempo de execução; tests/typed_api_sync.rs os mantém iguais às listas do motor.

from typing import TYPE_CHECKING
import kshana
if TYPE_CHECKING:
    from kshana import ScenarioKind

names: "list[ScenarioKind]" = [k["name"] for k in kshana.scenario_kinds()]

RunOutput#

A tabela de reprodutibilidade#

realtime-frame-eop, lunar-time-budget, lunar-jamming, telecom-timing e leo-navmsg sempre publicam uma tabela; moonlight-service-volume publica uma quando um local de exportação (export_site_lat_deg + export_site_lon_deg) está configurado. Todos os outros tipos de cenário devolvem csv = None. O texto são os mesmos bytes que a CLI (interface de linha de comando) grava como <scenario>.table.csv, de modo que um revisor que reproduz uma tabela publicada a partir da wheel nunca precise recorrer à linha de comando:

import kshana

out = kshana.run_typed(open("scenarios/realtime-frame-eop.toml").read())
if out.csv is not None:
    print(out.write_csv("table.csv"), "bytes written")

Forma do resultado#

As figuras de mérito e a série temporal ficam por lado da execução, não no nível superior. Para uma execução de relógio, o documento é:

schema_version  engine_version  scenario_hash  seed  threshold_ns  units  figure_tiers
quantum   → spec · series · fom · adev_curve · filter_health
classical → spec · series · fom · adev_curve · filter_health

de modo que as figuras de mérito são data["quantum"]["fom"], nunca data["figures_of_merit"]. Os outros tipos de cenário emitem seus próprios pacotes; a referência completa por campo, com unidades e uma indicação da fonte, é field-units-schema.json e o guia do leitor é SCHEMA.md.

Observações#

• validate_toml e error_kind executam o cenário, de modo que revelam erros de análise, de configuração e de execução. Eles nunca levantam exceção.
• run / run_typed levantam ValueError em um cenário inválido.
• Os resultados são reproduzíveis: um cenário carrega sua seed e o motor registra um scenario_hash, de modo que a mesma entrada produz uma saída idêntica byte a byte na mesma plataforma (consulte REPRODUCIBILITY.md).
• .array, .columns e .series devolvem exatamente numpy.asarray(...) dos mesmos valores que .data() fornece (mesmo dtype, idêntico bit a bit; tests/python/test_numpy_runoutput.py). Elas importam o NumPy quando chamadas e levantam ImportError sem ele; o NumPy fica fora dos requisitos de execução do pacote. KeyError significa que o caminho não existe, ValueError que o valor ali não é uma matriz numérica (ou não é uma lista de registros). Notebooks executáveis estão em notebooks/.

Fora do Python: processos de longa duração#

kshana receiver-trust live (um processo de fluxo com um gate e um servidor TCP --listen opcional) e os exportadores de telemetria (Prometheus, OTLP, syslog; docs/TRUST-TELEMETRY.md) e o fluxo de kshana nmea-scenario --tcp/--udp são exclusivos da linha de comando: uma ligação retorna quando a chamada retorna e não mantém um socket aberto. O Python cobre a forma em lote de cada um: receiver_trust para um registro, receiver_trust_replay para um trecho de fluxo (pontuações e estados; o gate não é aplicado), nmea_training para o texto gerado.