Command-line interface

Use eqiora check to compile a local .eqi file and find syntax, name, and unit errors before running a simulation.

Install the command

The command is a Rust executable. From the Eqiora source checkout used for your Python installation, install it with Cargo:

bash

cargo install --locked --path crates/eqiora --features cli --bin eqiora

Keep Cargo’s binary directory on PATH (normally ~/.cargo/bin). Installing the Python package alone does not install this command.

Check a model

Save this as decay.eqi:

eqiora

model decay(parameter rate: 1 / s = 1) {
    state x: 1;
    initial { x = 1; }
    relation flow {
        derivative(x) + rate * x = 0;
    }
}

bash

eqiora check decay.eqi

A successful check exits with status 0. It only compiles the model; to compute x(t), continue with the Python run example.

Change the parameter unit from 1 / s to s and run the check again. The compiler reports the incompatible dimensions and exits with a nonzero status. Fix the unit before choosing a numerical method.

For more syntax, see the language reference.

Version

console

$ eqiora --version
eqiora 0.1.3

Command help

console

$ eqiora --help
Compile and check one Eqiora Model source file.

Usage:
  eqiora check <MODEL_PATH>

Commands:
  check    Compile/check one local Model source file.

Options:
  -h, --help       Print help.
  -V, --version    Print version.

check help

console

$ eqiora check --help
Compile/check one local Eqiora Model source file.

Usage:
  eqiora check <MODEL_PATH>

Arguments:
  <MODEL_PATH>    UTF-8 path to one regular Model source file.

Options:
  -h, --help    Print help.