Skip to main content

psr.cloud (pycloud)

PSR Cloud Python module. Authenticate with PSR Cloud and submit, monitor, and retrieve model cases programmatically from Python.

Installation

From source (recommended)

Copy the psr folder and its contents to your working directory, or add its parent path to the PYTHONPATH environment variable.

pip

pip install git+https://github.com/psrenergy/pycloud.git

Quick example

import psr.cloud

client = psr.cloud.Client()

case = psr.cloud.Case(
    name="Test PyCloud",
    program="SDDP",
    program_version="18.0.9",
    data_path="C:\\PSR\\SDDP18.0\\examples\\operation",
    price_optimized=True,
    execution_type="Operation Planning (Default)",
    number_of_processes=64,
    memory_per_process_ratio="2:1",
)

client.run_case(case)

Interfaces

Besides the Python API above, the same capabilities are available through a CLI (console/), a REST API (api/, pip install -e .[server]), and an integrated desktop app (desktop/, pip install -e .[desktop]) that hosts the web UI and calls the service layer in-process — python -m desktop.app. All delegate to the shared, transport-agnostic api/service.py. The desktop app packages into a single Windows executable (front-end + back-end) via scripts\build_desktop_exe.batdist\PSRCloud.exe.

Documentation

Full documentation lives in docs/: authentication, querying PSR Cloud options, common workflows, and the complete API reference.

Preview it locally with:

uv run mkdocs serve

Contributing

The architecture and change conventions live in docs/architecture/ — start there (an auto-generated code map shows where every public symbol lives). The "definition of done" for any change is in docs/architecture/conventions.md.

Download files

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

Source Distribution

psr_cloud-0.4.1.tar.gz (70.0 kB view details)

Uploaded Source

Built Distribution

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

psr_cloud-0.4.1-py3-none-any.whl (62.4 kB view details)

Uploaded Python 3

File details

Details for the file psr_cloud-0.4.1.tar.gz.

File metadata

  • Download URL: psr_cloud-0.4.1.tar.gz
  • Upload date:
  • Size: 70.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.15

File hashes

Hashes for psr_cloud-0.4.1.tar.gz
Algorithm Hash digest
SHA256 e4765817ae2d41b35be9d93a62434e06f000399af4f63a244c118e4ca8f95736
MD5 d6e725ebff18d4cbdf76080fea24c2ba
BLAKE2b-256 7d668b9b05b9435e747e08ecb276996ccdd7e6ccd908040edc86ac88e30eb9cf

See more details on using hashes here.

File details

Details for the file psr_cloud-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: psr_cloud-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 62.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.15

File hashes

Hashes for psr_cloud-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bd82536b359de6aec79728bb09943a3a3470e7ba5230c4b959a2e0e304514f7b
MD5 093ff57b20e505a34e86b393c85dc582
BLAKE2b-256 18c150a2d3d74ca5d52d88cd85b6b8ab698e70342cf4d40226a0f1497c4d55aa

See more details on using hashes here.

Release history Release notifications | RSS feed

0.4.2

2 files

This release

0.4.1 This release

2 files

0.4.0

2 files

0.3.29

2 files

0.3.28

2 files

0.3.27

2 files

0.3.26

2 files

0.3.25

2 files

0.3.24

2 files

0.3.23

2 files

0.3.22

2 files

0.3.21

2 files

0.3.20

2 files

0.3.19

2 files

0.3.18

2 files

0.3.17

2 files

0.3.16

2 files

0.3.15

2 files

0.3.14

2 files

0.3.13

2 files

0.3.12

2 files

0.3.11

2 files

0.3.10

2 files

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