Skip to main content

Python bindings for Arco optimization library

Project description

Arco Python bindings

The Python package remains in bindings/python for path compatibility with existing build, release, and editable-install workflows. Its Rust crate is named arco-python and is the Python interaction surface; public Python imports stay under arco.

Python-facing solve orchestration is routed through the shared arco-ops facade where it overlaps with other interaction surfaces. The public Python API is unchanged.

Build and install locally with the repository solver setup:

just py-dev

Default Python builds include HiGHS, SCIP, and the runtime-loaded Xpress backend. Solving with arco.Xpress(...) still requires the FICO Xpress runtime and a valid license on the target machine.

For direct maturin workflows, run through the solver build environment so the bindings link against the cached HiGHS and SCIP distributions:

cd ../..
CARGO_INCREMENTAL=0 CARGO_PROFILE_DEV_DEBUG=0 ARCO_HIGHS_ENABLE_APPLE_STATIC=1 ./scripts/with_solver_build_env.sh \
  bash -lc 'cd bindings/python && uv sync --group dev && ./.venv/bin/maturin develop'

CARGO_INCREMENTAL=0 and CARGO_PROFILE_DEV_DEBUG=0 are intentional for cold editable builds: they avoid incremental bookkeeping and debug-info generation that slow a clean maturin develop build. Leave them unset for normal Rust edit-compile-test loops where incremental rebuilds and debug info help.

To enable the IPOPT nonlinear backend, build with the ipopt feature (requires a system IPOPT install):

cd bindings/python
uv run --with maturin maturin develop --features ipopt

To disable optional commercial or native solver features for a source build, turn off default Cargo features and opt back into the backends you need:

cd bindings/python
uv run --with maturin maturin develop --no-default-features --features pyo3/extension-module

Without a solver feature, that solver's Python class remains importable but solve will fail fast with a rebuild hint.

Run linting:

uv run ruff check .
uv run ty check .

Run Python example formulations from the repository root:

cd ../..
uv run examples/dense-lp/formulation.py --solve --json
uv run examples/sdom/formulation.py --solve --json

For interactive exploration of dense-lp (no extra script boilerplate):

cd ../..
uv run --with ipython --with-editable ./bindings/python ipython -i examples/dense-lp/formulation.py

Inside IPython, use model to inspect the formulation and call solve() when ready.

Running example problems

The examples/ tree contains standalone Python scripts that build models directly through the bindings, covering different problem classes:

  • LP — linear programs (default HiGHS backend).
  • MILP — mixed-integer linear programs (HiGHS).
  • NLP — nonlinear programs (requires bindings built with --features ipopt).
  • QP / QCP — (quadratically constrained) quadratic programs, solved through the appropriate backend for the problem class.

Run from bindings/python so the locally built extension is on the import path:

cd bindings/python

# LP — Multi-period DC-OPF (HiGHS)
uv run python ../../examples/multi-period-optimal-power-flow/dc-opf-24bus-wind-load-shedding/problem.py

# NLP — Multi-period AC-OPF (IPOPT)
uv run python ../../examples/multi-period-optimal-power-flow/ac-opf-24bus-wind-load-shedding/problem.py

Each script prints the solver status and final objective value alongside the reference value from the original formulation. Substitute the path to any other problem.py (or formulation.py) under examples/ to run a different model.

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

arco-0.9.0.tar.gz (2.4 MB view details)

Uploaded Source

Built Distributions

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

arco-0.9.0-cp311-abi3-win_amd64.whl (3.3 MB view details)

Uploaded CPython 3.11+Windows x86-64

arco-0.9.0-cp311-abi3-manylinux_2_38_x86_64.whl (4.1 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.38+ x86-64

arco-0.9.0-cp311-abi3-macosx_11_0_arm64.whl (3.3 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

arco-0.9.0-cp310-cp310-win_amd64.whl (3.3 MB view details)

Uploaded CPython 3.10Windows x86-64

arco-0.9.0-cp310-cp310-manylinux_2_38_x86_64.whl (4.1 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.38+ x86-64

arco-0.9.0-cp310-cp310-macosx_11_0_arm64.whl (3.3 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

File details

Details for the file arco-0.9.0.tar.gz.

File metadata

  • Download URL: arco-0.9.0.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for arco-0.9.0.tar.gz
Algorithm Hash digest
SHA256 04c8bbae3701715050e02573baf3d7e2d7d7ae12cc2f556d81063eab8b5c88ef
MD5 8d5eb52f0e96947340558bdfd24eaebd
BLAKE2b-256 0eb79746caba3e97c6310d0f585c3666f53a6f5de5cd64c338d7b7b37f058bb7

See more details on using hashes here.

Provenance

The following attestation bundles were made for arco-0.9.0.tar.gz:

Publisher: release-please.yaml on NatLabRockies/arco

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

File details

Details for the file arco-0.9.0-cp311-abi3-win_amd64.whl.

File metadata

  • Download URL: arco-0.9.0-cp311-abi3-win_amd64.whl
  • Upload date:
  • Size: 3.3 MB
  • Tags: CPython 3.11+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for arco-0.9.0-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 9aebe1bf338e2931e26794a42fa25cf7e1e6d340dc51ad5a6a22954f75839fe1
MD5 7f5264a4429bbd4d2181d197b934692c
BLAKE2b-256 3eba65f2157a093ed70f9aa1c04e6c71f12e66b4ee617954a1230da16270b758

See more details on using hashes here.

Provenance

The following attestation bundles were made for arco-0.9.0-cp311-abi3-win_amd64.whl:

Publisher: release-please.yaml on NatLabRockies/arco

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

File details

Details for the file arco-0.9.0-cp311-abi3-manylinux_2_38_x86_64.whl.

File metadata

File hashes

Hashes for arco-0.9.0-cp311-abi3-manylinux_2_38_x86_64.whl
Algorithm Hash digest
SHA256 957aa8e85ff707616c1856f619038c5ca115cdee7d3010d5c40ada474cb3125e
MD5 ff6a874c899537e8836c51cec37c2391
BLAKE2b-256 2ece4517186c910d96017af846f7d3b50af70d35fc188a9ebc4babaa07648f12

See more details on using hashes here.

Provenance

The following attestation bundles were made for arco-0.9.0-cp311-abi3-manylinux_2_38_x86_64.whl:

Publisher: release-please.yaml on NatLabRockies/arco

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

File details

Details for the file arco-0.9.0-cp311-abi3-macosx_11_0_arm64.whl.

File metadata

  • Download URL: arco-0.9.0-cp311-abi3-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 3.3 MB
  • Tags: CPython 3.11+, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for arco-0.9.0-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4d852a995c137e58e6c0bb496b9f80aee0e65ee9281f995cc0e4d6a2629859f4
MD5 8a272c4a2b079e74090de05cb2ef21f2
BLAKE2b-256 fb6013dffcb20c804fa4785dba3847b8b4159964b6790997d2f2a38abd235ab2

See more details on using hashes here.

Provenance

The following attestation bundles were made for arco-0.9.0-cp311-abi3-macosx_11_0_arm64.whl:

Publisher: release-please.yaml on NatLabRockies/arco

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

File details

Details for the file arco-0.9.0-cp310-cp310-win_amd64.whl.

File metadata

  • Download URL: arco-0.9.0-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 3.3 MB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for arco-0.9.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 8c836a0af9b029bb45df6fc87f7d2044a2c5c67e1c589aa8123090a2aa66e6ed
MD5 8ef041eef58bb4ea750586793acf105b
BLAKE2b-256 da2f52d8d18b82d225a85048612112888ad416446a0bf9d044648a5c2dc993e6

See more details on using hashes here.

Provenance

The following attestation bundles were made for arco-0.9.0-cp310-cp310-win_amd64.whl:

Publisher: release-please.yaml on NatLabRockies/arco

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

File details

Details for the file arco-0.9.0-cp310-cp310-manylinux_2_38_x86_64.whl.

File metadata

File hashes

Hashes for arco-0.9.0-cp310-cp310-manylinux_2_38_x86_64.whl
Algorithm Hash digest
SHA256 c5f4b5e17c5b9d824c9663bd936ffcbaa675afbd9ee229278484477bb56ce680
MD5 40b0bf5b5125dead7725db8062f98d32
BLAKE2b-256 fa81c8b0f20dc7fa5ca6f21a3510d72770f30dbe82c3d730d5f224d03838e54a

See more details on using hashes here.

Provenance

The following attestation bundles were made for arco-0.9.0-cp310-cp310-manylinux_2_38_x86_64.whl:

Publisher: release-please.yaml on NatLabRockies/arco

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

File details

Details for the file arco-0.9.0-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for arco-0.9.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 47042919ca86b65c6a6e46a3879ecea5a8e07a51cfa2729a6eaf37dcd42dddab
MD5 38637fe54cc2d1ce8017f0bd1e371e4c
BLAKE2b-256 fdaaa397e3aef2c9ed86c0fc3efbd39c31ff1e9e07889155d9c44f2be1b2f1fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for arco-0.9.0-cp310-cp310-macosx_11_0_arm64.whl:

Publisher: release-please.yaml on NatLabRockies/arco

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