Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Install

Most users need exactly one command:

pip install pyaviso
aviso --version

The Python package carries both surfaces: the importable pyaviso library and the aviso command-line tool. The wheel installs the CLI as a console script that runs the Rust core in-process, so there is no Rust toolchain to set up and no separate binary to download.

You want toInstall
Call aviso from Pythonpip install pyaviso
Run the aviso command-line toolpip install pyaviso (the CLI is bundled), or cargo install aviso-cli for a Rust-native binary
Use the Rust library in your own cratecargo add aviso

Command line without Python

If you do not use Python, cargo builds the same CLI from source:

cargo install aviso-cli
aviso --version

cargo install puts the binary in ~/.cargo/bin/aviso, which is on your PATH if you installed Rust through rustup. Both install paths give you the same aviso command and behaviour.

The CLI install page covers the from-source path and how to verify your install.

Rust library, in your Cargo.toml

[dependencies]
aviso = "2.0"
tokio = { version = "1.53", features = ["macros", "rt-multi-thread"] }
serde_json = "1.0"

aviso is async and runs on tokio. The full library guide is in the developers section.

What you need on the server side

Whichever surface you pick, you will need:

  • The base URL of an aviso-server you can talk to (your team or ECMWF gives you this).
  • Credentials, when the server requires them (usually a bearer token).

See authentication providers for the five ways to attach credentials.