Skip to main content

Thin Python client for the licensed YACS desktop engine

Project description

yacs-python

yacs-python is the small, dependency-free Python interface to the licensed YACS desktop engine. It provides secure local discovery, background-job helpers, and a command-line interface. It contains no circuit solver or other proprietary YACS implementation code.

Install

Install into the Python environment that will automate YACS:

python -m pip install yacs-python

YACS Desktop must be installed and have a valid license. Installing this package does not install or unlock the solver.

Python API

from yacs_python import Desktop

with Desktop.connect() as yacs:
    result = yacs.analyze(circuit, analysis)

Long-running operations can be managed explicitly:

with Desktop.connect() as yacs:
    job = yacs.analyze(circuit, analysis, wait=False)
    print(job.status())
    result = job.result()

For large results, job.download("result.json") streams to a temporary file, verifies the engine-provided SHA-256 digest, and only then atomically replaces the destination.

CLI

yacs status
yacs analyze request.json --output result.json
yacs run refine_roots request.json --output roots.json

The v1 API accepts normalized JSON request objects. Complete .yacs workspace parsing remains engine-owned so client releases do not duplicate private or rapidly evolving desktop normalization rules.

Security boundary

The client connects only to numeric loopback addresses discovered through a private per-session descriptor. It rejects redirects, bypasses system HTTP proxies, verifies the engine instance handshake, and receives a scoped token that cannot access desktop or licensing-control endpoints.

The descriptor is a short-lived capability available to processes running as the same operating-system user. Do not copy or publish it.

Compatibility

Client releases are versioned independently from YACS Desktop. This release supports YACS Desktop Automation API v1.

Development and managed-installation overrides:

  • YACS_APP_PATH
  • YACS_CONNECTION_FILE
  • YACS_AUTOMATION_SESSION_DIR

License

The client is MIT licensed. YACS Desktop and its numerical engine are separate products governed by their own license terms.

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

yacs_python-0.1.0a3.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

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

yacs_python-0.1.0a3-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file yacs_python-0.1.0a3.tar.gz.

File metadata

  • Download URL: yacs_python-0.1.0a3.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for yacs_python-0.1.0a3.tar.gz
Algorithm Hash digest
SHA256 012f99ccaac4b3550f72230a45fe1ef3db5f758fb27ef79dbbc3efc091640e9c
MD5 d49e9756c83dc9fee33b156e0253a7d1
BLAKE2b-256 cd3bece9a8bfbc877b4ac19f22d99cb559974db1751ce9d71c4cd95c8db6acf2

See more details on using hashes here.

Provenance

The following attestation bundles were made for yacs_python-0.1.0a3.tar.gz:

Publisher: publish.yml on David-Pahl/yacs-python

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

File details

Details for the file yacs_python-0.1.0a3-py3-none-any.whl.

File metadata

  • Download URL: yacs_python-0.1.0a3-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for yacs_python-0.1.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 35e44bd70984c32081153176847365b72ca8abd6d97a90bc9cf46e5b07690a72
MD5 a52e4451204bb4ae06539ac4e2441bad
BLAKE2b-256 27d81496ea9076ba4c09f9f1e49b3c1d7aab7152e005908416f8209b82f4898d

See more details on using hashes here.

Provenance

The following attestation bundles were made for yacs_python-0.1.0a3-py3-none-any.whl:

Publisher: publish.yml on David-Pahl/yacs-python

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