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.bat →
dist\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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file psr_cloud-0.4.2.tar.gz.
File metadata
- Download URL: psr_cloud-0.4.2.tar.gz
- Upload date:
- Size: 69.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
323e644004cde9df3d13be2d5e98592f06fa72efb6bf47dfe9cd5624eba28873
|
|
| MD5 |
76404e3ae3ad28329dfc9b6dc402bd60
|
|
| BLAKE2b-256 |
e394150dfe82a3c2fe31b6aa2718a71ac6595a87998eb351625f4cba9ae1b4c2
|
File details
Details for the file psr_cloud-0.4.2-py3-none-any.whl.
File metadata
- Download URL: psr_cloud-0.4.2-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4819745e24b0ae74704490895a9ec9c07895fa9ceea746aa4b05dfa378976c68
|
|
| MD5 |
57777daf6bae0fae120b8f13aa7ded61
|
|
| BLAKE2b-256 |
1b57cd4505f86c756796e5c1c202aa3b4fa6a7211dccad99ec5a4d502f14ffa2
|
