Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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 (PyPI may still show opensees-cli in the page title; that is the same project—hyphens and underscores are equivalent there.)

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 you@example.com

# 2) Confirm account
ops auth confirm --email you@example.com --code 123456

# 3) Log in
ops auth login --email you@example.com

# 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 you@example.com
ops auth confirm --email you@example.com --code 123456
ops auth resend-code --email you@example.com
ops auth login --email you@example.com
ops auth logout
ops auth status
ops auth forgot-password --email you@example.com
ops auth reset-password --email you@example.com --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 you@example.com
ops auth reset-password --email you@example.com --code 123456

Metadata

Release files for opensees-cli 0.1.0a10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opensees-cli 0.1.0a10
File Size Uploaded Provenance Actions
opensees_cli-0.1.0a10.tar.gz 49.0 kB Without provenance Details for opensees_cli-0.1.0a10.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for opensees-cli 0.1.0a10
File Interpreter ABI Platform Actions
opensees_cli-0.1.0a10-py3-none-any.whl Python 3 none any Details for opensees_cli-0.1.0a10-py3-none-any.whl

Total release size: 94.2 kB

Release files / opensees_cli-0.1.0a10.tar.gz

Download URL opensees_cli-0.1.0a10.tar.gz
Size 49.0 kB
Tags Source
SHA-256 checksum
How to use checksums
3eb8cdab4c0d9e2b612d7e45b9a63d6f4b21f1cb22c72f534070fc50f0251c1c
BLAKE2b-256 checksum
How to use checksums
b8690d5ad7098f32293ef87ca48153a6ec74205c878e5a79988f2c0fe9a15d2c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.8

Release files / opensees_cli-0.1.0a10-py3-none-any.whl

Download URL opensees_cli-0.1.0a10-py3-none-any.whl
Size 45.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4c59c0892ba31594df605dff787d4e6c0ff30f29c6ba24bb338dd3cd1d75ec7b
BLAKE2b-256 checksum
How to use checksums
2b5fc7cc48abb42c8294834424b1ca907cc4eb9e3b19326228c11b8b52d05ca1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.8

Security for opensees-cli 0.1.0a10

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page