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
- Source: https://github.com/Soft-CPS-Research-Group/Simulator
- Original upstream project: https://github.com/intelligent-environments-lab/CityLearn
1 maintainer
Metadata
1 maintainer
Release files for softcpsrecsimulator 1.9.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| softcpsrecsimulator-1.9.1.tar.gz | 614.7 kB | Without provenance | Details for softcpsrecsimulator-1.9.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| softcpsrecsimulator-1.9.1-py3-none-any.whl | Python 3 | none | any | Details for softcpsrecsimulator-1.9.1-py3-none-any.whl |
Total release size: 1.2 MB
Release files / softcpsrecsimulator-1.9.1.tar.gz
| Download URL | softcpsrecsimulator-1.9.1.tar.gz |
|---|---|
| Size | 614.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0e52fc30a891e648ff6b402c5a3aae6f74074ad7aee7019eb8a65a2adcf96a5c
|
|
BLAKE2b-256 checksum How to use checksums |
b1a3784ce10a1ef7c377c29497c2bfbbc25a05a76870560cc725edef4de80715
|
| 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.1-py3-none-any.whl
| Download URL | softcpsrecsimulator-1.9.1-py3-none-any.whl |
|---|---|
| Size | 561.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2087e75553adceb0778ae521bf671a1b53c2b53792b20ad150d9d5fef12f7f94
|
|
BLAKE2b-256 checksum How to use checksums |
12b8d54381214c5bacf1015ef5161abb0c9eefd56af208bc3024e7c513f18918
|
| 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.1
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.
