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.6.1.tar.gz (573.4 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.6.1-py3-none-any.whl (534.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for softcpsrecsimulator-1.6.1.tar.gz
Algorithm Hash digest
SHA256 3a0f4ad57fc23252a7418b886a64401a707dc56a195447803a11eced433817d8
MD5 997515cfe2bf7b8e3087495018fe6f6b
BLAKE2b-256 5cc9d6412e36aff4a399e25b367044d46f912f651102516edff0a01b53128ffd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for softcpsrecsimulator-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 898cbb8f89d76b5fcff3febc55ac412c2a09a53c525283b2953d5b33690a8453
MD5 72e5b98aae95f535268edb6e582eb4dc
BLAKE2b-256 c85b6260df73f6883cb1f9edc398d7af60788991910ab8fc7f1b1382e5516134

See more details on using hashes here.

Release history Release notifications | RSS feed

1.8.0

2 files

1.7.0

2 files

This release

1.6.1 This release

2 files

1.5.6

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