Skip to main content

SoftCPS REC Simulator

softcpsrecsimulator is a simulation framework maintained by the SoftCPS Research Group for energy-community studies with reinforcement learning.

It is a fork-based project used for research and experimentation on:

  • electric vehicles (EVs) and chargers,
  • stationary batteries (BESS),
  • photovoltaic generation (PV),
  • electrical-service constraints (single/three-phase),
  • local community market settlement and KPI analysis.
  • entity-mode RL observation contracts with derived forecasts, physical deadlines, feasible action capacity and requested/limited/applied action feedback.
  • dynamic member and asset topology with repeatable multi-episode reset semantics.

Current source release: 1.9.0. This release adds passive energy provenance through stationary batteries, EVs and community sharing, useful solar-energy indicators and carbon accounting at the external grid boundary. EV departure feasibility uses the concrete battery physics. KPI exports include reproducibility manifests. Existing instantaneous PV and gross-import emissions remain available with their historical meanings. See the release notes for validation and limits.

Project Positioning

This package is a fork project built from the CityLearn codebase and extended for SoftCPS REC simulation needs.

Installation

pip install softcpsrecsimulator

Python Usage

For compatibility with existing ecosystems, the Python module path currently remains:

from citylearn.citylearn import CityLearnEnv

Source and Documentation

Metadata

Release files for softcpsrecsimulator 1.9.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for softcpsrecsimulator 1.9.9
File Size Uploaded Provenance Actions
softcpsrecsimulator-1.9.9.tar.gz 678.3 kB Without provenance Details for softcpsrecsimulator-1.9.9.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for softcpsrecsimulator 1.9.9
File Interpreter ABI Platform Actions
softcpsrecsimulator-1.9.9-py3-none-any.whl Python 3 none any Details for softcpsrecsimulator-1.9.9-py3-none-any.whl

Total release size: 1.3 MB

Release files / softcpsrecsimulator-1.9.9.tar.gz

Download URL softcpsrecsimulator-1.9.9.tar.gz
Size 678.3 kB
Tags Source
SHA-256 checksum
How to use checksums
33c802592f8a88a7601eb4c4d8c38eae48c0cab14a85528c50f47bc5545dacf3
BLAKE2b-256 checksum
How to use checksums
1098f568c1007ab65b51002dd7234f2530c99c0ab02af50e3dd8359b87e6fc8c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / softcpsrecsimulator-1.9.9-py3-none-any.whl

Download URL softcpsrecsimulator-1.9.9-py3-none-any.whl
Size 599.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4d35e5d11cd776f0c1f0bc66938473952849a254b8e508bcb8056c56ab77f538
BLAKE2b-256 checksum
How to use checksums
6e44747a98ccf5c2bd1620acab3f584b8045fe560cc5f109e303965980eb6c23
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for softcpsrecsimulator 1.9.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.9.9 This release

2 release files No provenance

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