PSR Factory

Factory is a library that helps to manage SDDP cases. It contains functions that create, load, and save studies, and also functions that create, access, and modify objects in a study.

Home page: https://www.psr-inc.com/knowledge/solutions/additional_tools/factory/getting_started/introduction.html

Installation

Open the command prompt and run the following command:

pip install psr-factory

Factory will be available to all Python scripts in your system after importing it:

import psr.factory

Usage sample

import psr.factory

study = psr.factory.load_study(r"C:\temp\my\study")
system_1 = study.find("System.*")[0]

battery = study.create("Battery")
battery.code = 1
battery.name = "Battery 1"
battery.set("InstalledCapacity", 10.0)
battery.set("RefSystem", system_1)
study.add(battery)

study.save(r"C:\temp\my\updated_study")

Reading results

load_dataframe reads a result file whole. When one is too large for that -- an hourly case easily is -- scan_dataframe reads it in batches, so memory follows the batch size and not the file size:

import psr.factory

with psr.factory.scan_dataframe(r"C:\case\gerter.hdr",
                                batch_rows=100_000,
                                filter_agents=["Thermal 1"]) as scan:
    peak = max(float(batch["Thermal 1"].max()) for batch in scan)

psr.factory.write_dataframe(destination, scan) writes one back the same way, so a whole file-to-file transform never holds either end. Batches are ordinary DataFrame objects: index them with numpy, or convert with to_pandas() / to_polars(), or hand them straight to pyarrow, polars or DuckDB through the Arrow protocol.

Full documentation

The full documentation and reference is available at https://docs.psr-inc.com/knowledgehub/solutions/additional_tools/factory/getting_started/introduction.html.

Licensing

PSR Factory is commercial, proprietary software. It is not open source. Installing it from PyPI does not by itself grant a right to use it.

• The software licence is the PSR Factory Software License Agreement, distributed with every wheel as LICENSE.txt (inside the installed package at psr_factory-<version>.dist-info/licenses/LICENSE.txt). Installing or using the package means accepting it. It is offered as an annual, renewable subscription.
• A runtime licence is separate. The agreement governs your right to use the software; a valid PSR licence is what makes it run. Check yours with psr.factory.check_license().
• Redistributing the unmodified package is permitted — mirrors, internal package indexes and container images are all fine. Whoever receives it still needs their own PSR licence to run it.
• Third-party components. Factory links a number of third-party libraries. Their licences are reproduced in full in THIRD_PARTY_NOTICES.txt, shipped beside LICENSE.txt. Nothing in the PSR Factory agreement limits any right you hold under those licences.

Licensing enquiries: psrfactory@psr-inc.com

Releases

New releases can be found in PyPI website at https://pypi.org/project/psr-factory.

And the release notes at https://psrenergy-docs.github.io/factory/releases.html.