opensees-cli 0.1.0a7

Run OpenSees simulations in the cloud from the command line.

OpenSees CLI Documentation

Command-line interface for authentication and simulation runs.

Install

pip install opensees_cli

The PyPI distribution name matches the import name: import opensees_cli and python -m opensees_cli.

Package page: pypi.org/project/opensees_cli.

PATH and the ops command

After install, pip places the ops launcher in a scripts directory (e.g. Scripts on Windows, bin on macOS/Linux). That folder might not be on your PATH, so ops may be missing in a new terminal.

• On the first interactive run, the CLI can offer to add that folder to your PATH automatically.
• To always run that step (for example on Windows), use:

python -m opensees_cli set_path

Answer Y when prompted. Open a new terminal afterward, then try ops version.

If ops is still not found, you can run the same program with:

python -m opensees_cli

To see the PATH offer again after you skipped it, delete the marker file ~/.opensees/path_fixed (on Windows: %USERPROFILE%\.opensees\path_fixed) and run python -m opensees_cli or python -m opensees_cli set_path.

Quick Start

# 1) Create account
ops auth signup --email [e-mail]

# 2) Confirm account
ops auth confirm --email [e-mail] --code 123456

# 3) Log in
ops auth login --email [e-mail]

# 4) Submit a simulation
ops run submit ./model.py --timeout 300 --wait

Top-Level Commands

ops set_path
ops version
ops status
ops quota
ops help

• set_path: interactive prompt to add the ops launcher directory to your PATH (use python -m opensees_cli set_path if ops is not on PATH yet)
• version: print CLI version
• status: show account details, signup time, and quota (calls the API)
• quota: show your current run quota

Auth Commands

ops auth signup --email [e-mail]
ops auth confirm --email [e-mail] --code 123456
ops auth resend-code --email [e-mail]
ops auth login --email [e-mail]
ops auth logout
ops auth status
ops auth forgot-password --email [e-mail]
ops auth reset-password --email [e-mail] --code 123456
ops auth change-password
ops auth help

Run Commands

ops run submit ./model.py --timeout 120 --wait
ops run status <run_id>
ops run output <run_id>
ops run result <run_id>
ops run cancel <run_id>
ops run list --limit 20
ops run help

run submit options

• file (required positional): path to a .py simulation script
• --timeout, -t: max wall time per task in seconds (default 120). The API requires your monthly runtime remaining ≥ timeout × number of tasks. Runs above 900s use Fargate when configured; otherwise the 900s Lambda limit applies.
• --wait/--no-wait: stream output until completion (default --wait)

Validation enforced by CLI:

• file must exist
• file extension must be .py
• file size must be <= 200 KB

Common Workflows

Check account + quota

ops status
ops quota

Submit and monitor a run later

ops run submit ./model.py --no-wait
ops run status <run_id>
ops run output <run_id>
ops run result <run_id>

Reset password

ops auth forgot-password --email [e-mail]
ops auth reset-password --email [e-mail] --code 123456