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.5.6. Dynamic environments restore their schema-loaded topology before replaying episode events, preventing structural state from leaking between training episodes.

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

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.8.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for calof from gravatar.com calof

Credits

Author: Soft-CPS Research Group, Jose Ramon Vazquez-Canteli, Kingsley Nweye, Zoltan Nagy

License

MIT License (MIT)

Requires

Python >=3.9

Provides Extra

parquet pysam

Classifiers

Report project as malware

Download files

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

Source Distribution

softcpsrecsimulator-1.5.6.tar.gz (567.9 kB view details)

Uploaded Source

Built Distribution

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

softcpsrecsimulator-1.5.6-py3-none-any.whl (530.0 kB view details)

Uploaded Python 3

File details

Details for the file softcpsrecsimulator-1.5.6.tar.gz.

File metadata

  • Download URL: softcpsrecsimulator-1.5.6.tar.gz
  • Upload date:
  • Size: 567.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for softcpsrecsimulator-1.5.6.tar.gz
Algorithm Hash digest
SHA256 7718e9f3c9cecd24f7a6fb209fc936f1e7520f39d08448d4f30f1c11bc3a1383
MD5 1487b3a17ea8f0298c39c48884551e75
BLAKE2b-256 f42da997dd265fa4d937aedba0a338af5dad49a1dc6e27a5e4c64ffb261132e7

See more details on using hashes here.

File details

Details for the file softcpsrecsimulator-1.5.6-py3-none-any.whl.

File metadata

File hashes

Hashes for softcpsrecsimulator-1.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 025bb1224f9db3c2a8cbeb46e640771dc5e18b64e0afc42fceda576c9ef7f5f8
MD5 815be5647a2da65e091b07d8597f6c24
BLAKE2b-256 bf39de6b1982b3f7735305f3c5164e0f2c8f53ca5e51b7e12343d9faa67245ca

See more details on using hashes here.

Release history Release notifications | RSS feed

1.8.0

2 files

1.7.0

2 files

1.6.1

2 files

This release

1.5.6 This release

2 files

1.5.4

2 files

1.5.3

2 files

1.5.1

2 files

1.5.0

2 files

1.4.0

2 files

1.1.0

2 files

1.0.2

2 files

1.0.1

2 files

0.6.9

2 files

0.6.7

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.3

2 files

0.4.0

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.1.1

2 files

0.1.0

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