Skip to main content

Anything-to-Cobre converter

Project description

cobre-bridge

Convert power system data formats to Cobre input format.

Installation

# Recommended: isolated, on-PATH CLI
uv tool install cobre-bridge

# Alternative
pipx install cobre-bridge

# With cobre-python, so `convert --validate` can validate the output
uv tool install "cobre-bridge[validation]"

Requires Python >= 3.12.

Usage

Command What it does
cobre-bridge convert newave <SRC> <DST> Convert a NEWAVE case to Cobre input format.
cobre-bridge check newave <SRC> Preflight-validate NEWAVE inputs (no conversion).
cobre-bridge compare bounds <NEWAVE_DIR> <COBRE_DIR> Compare LP bounds between the two cases.
cobre-bridge compare results <NEWAVE_DIR> <COBRE_DIR> Compare simulation results against Cobre output.
cobre-bridge dashboard <CASE_DIR> Build an interactive HTML dashboard from Cobre results.

Every command accepts --json (a single machine-readable verdict {schema_version, command, status, summary, diagnostics} on stdout) and -v/-vv, --log-file PATH, --no-color, --quiet. convert adds --validate, --force, --dry-run, --diagnostics-json PATH. dashboard adds --open. compare adds --tolerance, --format, --out-dir (and compare bounds also --summary, --variables).

See docs/cli.md for the full per-command reference.

Future (NE) hydro plants. convert newave converts NEWAVE NE (future, will-be-built) plants using cobre's dead-volume filling schema. A converted case containing NE plants requires cobre >= 0.9.1; EX-only cases still load on cobre >= 0.8.2. With cobre-python >= 0.9.1 installed, convert --validate validates these cases too; an older cobre-python that predates the filling schema is skipped gracefully.

Configuration

Defaults for compare tolerance, format, and out_dir can be set in a cobre-bridge.toml file (discovered from the working directory upward, then $XDG_CONFIG_HOME/cobre-bridge/config.toml, then ~/.config/cobre-bridge/config.toml) or via COBRE_BRIDGE_* environment variables (e.g. COBRE_BRIDGE_BOUNDS_TOLERANCE, COBRE_BRIDGE_FORMAT, COBRE_BRIDGE_OUT_DIR). Precedence is flag > env > config file > default.

Shell completion

cobre-bridge --install-completion   # install for your shell
cobre-bridge --show-completion      # print the script

Development

pip install -e ".[dev]"
pytest
ruff check src/

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cobre_bridge-0.9.1.tar.gz (767.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cobre_bridge-0.9.1-py3-none-any.whl (454.3 kB view details)

Uploaded Python 3

File details

Details for the file cobre_bridge-0.9.1.tar.gz.

File metadata

  • Download URL: cobre_bridge-0.9.1.tar.gz
  • Upload date:
  • Size: 767.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cobre_bridge-0.9.1.tar.gz
Algorithm Hash digest
SHA256 b4bfa75bbb322cd89708b745200a0114a0038bb472f0961b66f0d6cd78586990
MD5 ef98a3388ba6f1a408745704e13d83d7
BLAKE2b-256 63f88c0bf64c4cc9722e417ebb13f91fe02f69db4d0c375bf009b4bd41ef052b

See more details on using hashes here.

Provenance

The following attestation bundles were made for cobre_bridge-0.9.1.tar.gz:

Publisher: release.yml on cobre-rs/cobre-bridge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cobre_bridge-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: cobre_bridge-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 454.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cobre_bridge-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 892b62d0828ecd1a02ba128a9da5c57b62a0d92bc4862d6a38b9dff3a5f12a8d
MD5 c7ddbcc67b323fd098e998d4a3c69674
BLAKE2b-256 28bc18e753f42d1fad707edadfde4439f61d93905b2910c100b462cb4e94fac5

See more details on using hashes here.

Provenance

The following attestation bundles were made for cobre_bridge-0.9.1-py3-none-any.whl:

Publisher: release.yml on cobre-rs/cobre-bridge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page