softcpsrecsimulator 0.1.0__tar.gz

softcpsrecsimulator-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Jose Ramon Vazquez-Canteli, Intelligent Environments Laboratory
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

softcpsrecsimulator-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include citylearn/assets/*
+recursive-include citylearn/misc *
+include requirements.txt

softcpsrecsimulator-0.1.0/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: softcpsrecsimulator
+Version: 0.1.0
+Summary: An open source Farama Foundation Gymnasium environment for benchmarking distributed energy resource control algorithms to provide energy flexibility in a district of buildings.
+Home-page: https://github.com/Soft-CPS-Research-Group/Simulator
+Author: Soft-CPS Research Group, Jose Ramon Vazquez-Canteli, Kingsley Nweye, Zoltan Nagy
+Author-email: jose@isep.ipp.pt
+License: MIT
+Project-URL: Source, https://github.com/Soft-CPS-Research-Group/Simulator
+Project-URL: Original Project, https://github.com/intelligent-environments-lab/CityLearn
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: doe_xstock>=1.1.0
+Requires-Dist: gymnasium<=0.28.1
+Requires-Dist: nrel-pysam
+Requires-Dist: numpy<2.0.0
+Requires-Dist: pandas
+Requires-Dist: pyyaml
+Requires-Dist: scikit-learn<=1.2.2
+Requires-Dist: simplejson
+Requires-Dist: torch
+Requires-Dist: torchvision
+Requires-Dist: openstudio<=3.3.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# CityLearn
+CityLearn is an open source Farama Foundation Gymnasium environment for the implementation of Multi-Agent Reinforcement Learning (RL) for building energy coordination and demand response in cities. A major challenge for RL in demand response is the ability to compare algorithm performance. Thus, CityLearn facilitates and standardizes the evaluation of RL agents such that different algorithms can be easily compared with each other.
+
+![Demand-response](https://github.com/intelligent-environments-lab/CityLearn/blob/master/assets/images/dr.jpg)
+
+## Environment Overview
+
+CityLearn includes energy models of buildings and distributed energy resources (DER) including air-to-water heat pumps, electric heaters and batteries. A collection of building energy models makes up a virtual district (a.k.a neighborhood or community). In each building, space cooling, space heating and domestic hot water end-use loads may be independently satisfied through air-to-water heat pumps. Alternatively, space heating and domestic hot water loads can be satisfied through electric heaters.
+
+![Citylearn](https://github.com/intelligent-environments-lab/CityLearn/blob/master/assets/images/environment.jpg)
+
+## Installation
+Install latest release in PyPi with `pip`:
+```console
+pip install softcpsrecsimulator
+```
+
+Python import path remains:
+```python
+from citylearn.citylearn import CityLearnEnv
+```
+
+## Developer Commands
+Use the repository virtual environment when available:
+
+```console
+.venv/bin/pytest -q
+```
+
+Critical lint checks used in CI:
+
+```console
+.venv/bin/python -m ruff check citylearn tests scripts/manual scripts/ci --select E9,F821
+```
+
+Manual utility scripts live in `scripts/manual` and are excluded from default pytest collection:
+
+```console
+python scripts/manual/demo_ev_rbc.py
+python scripts/manual/demo_ev_rbc_export_end.py
+```
+
+Runtime benchmark (main training resolutions 5s/60s):
+
+```console
+python scripts/manual/bench_runtime.py --seconds 5 60 --render-modes none end --episode-steps 1200
+```
+
+CI performance smoke check command:
+
+```console
+python scripts/ci/perf_smoke.py --episode-steps 600 --seconds 60 --baseline-file scripts/ci/perf_baseline.json
+```
+
+## Publish This Fork to PyPI
+This fork is configured to publish the distribution name `softcpsrecsimulator`.
+
+1. Create the package on PyPI (project name: `softcpsrecsimulator`).
+2. In GitHub repo settings, add secret `PYPI_API_TOKEN` with a PyPI token that can publish this project.
+3. Bump `citylearn/__init__.py` version.
+4. Push commit and create a GitHub Release (or run `Publish Python Package` workflow manually).
+5. Workflow `.github/workflows/pypi_deploy.yml` builds `dist/*` and uploads to PyPI.
+
+Optional local build check:
+```console
+python -m pip install --upgrade pip build twine
+python -m build
+python -m twine check dist/*
+```
+
+## Internal Architecture
+Public APIs remain in `CityLearnEnv` and `Building`, while internal orchestration is split into service modules under `citylearn/internal`:
+
+- `loading.py`: schema-driven loading/build assembly (`_load*`, metadata processing).
+- `runtime.py`: episode runtime orchestration (`step`, action parsing, time progression, EV/charger association).
+- `building_ops.py`: building observation/action orchestration.
+- `kpi.py`: KPI/evaluation pipeline.
+
+## Export and Render Modes
+`CityLearnEnv` keeps export off by default:
+
+- `render_mode='none'`: no CSV export and minimal runtime overhead.
+- `render_mode='during'`: writes CSV rows at each environment step.
+- `render_mode='end'`: keeps the rollout fast and writes full episode CSVs when the episode ends.
+
+Optional location controls:
+
+- `render_directory`: base folder for exports.
+- `render_session_name`: session subfolder name under `render_directory` (or `render_directory_name`).
+- `render_directory_name`: legacy fallback folder under project root when `render_directory` is not set.
+- `render`: legacy boolean flag; still supported for compatibility.
+
+Examples:
+
+```python
+from citylearn.citylearn import CityLearnEnv
+
+# Fast training/no export
+env = CityLearnEnv(schema, render_mode='none')
+
+# Stream CSVs every step
+env = CityLearnEnv(
+    schema,
+    render_mode='during',
+    render_directory='outputs',
+    render_session_name='run_during'
+)
+
+# Export once at episode end
+env = CityLearnEnv(
+    schema,
+    render_mode='end',
+    render_directory='outputs',
+    render_session_name='run_end'
+)
+```
+
+## Documentation
+Refer to the [docs](https://intelligent-environments-lab.github.io/CityLearn/).
+
+## CityLearn UI
+
+CityLearn UI is a visual dashboard for exploring simulation data generated by the CityLearn framework. It was developed to simplify the analysis of results from smart energy communities, district energy coordination, demand response (among other applications), allowing users to visually inspect building-level components, compare simulation KPIs, and create simulation schemas with ease.
+
+The interface is available in two options:
+
+* Web app: https://citylearnui.netlify.app/ (free hosted version — not recommended for sensitive/personal data)
+* Open-source code: https://github.com/Soft-CPS-Research-Group/citylearn-ui
+
+You can check a tutorial at the official CityLearn [website](https://intelligent-environments-lab.github.io/CityLearn/ui.html), in the CityLearn UI repository [README](https://github.com/Soft-CPS-Research-Group/citylearn-ui), or at the help [tooltip of the oficial webapp](https://citylearn-ui.netlify.app/admin/help).
+
+**Compatibility:** This version of the UI currently supports CityLearn v2.5.0 simulation data.
+
+**Developed by:** José, a member of the [SoftCPS](https://www2.isep.ipp.pt/softcps/), Software for Cyber-Physical Systems research group (ISEP, Portugal) in collaboration with the Intelligent Environments Lab, University of Texas at Austin.

softcpsrecsimulator-0.1.0/README.md

@@ -0,0 +1,134 @@
+# CityLearn
+CityLearn is an open source Farama Foundation Gymnasium environment for the implementation of Multi-Agent Reinforcement Learning (RL) for building energy coordination and demand response in cities. A major challenge for RL in demand response is the ability to compare algorithm performance. Thus, CityLearn facilitates and standardizes the evaluation of RL agents such that different algorithms can be easily compared with each other.
+
+![Demand-response](https://github.com/intelligent-environments-lab/CityLearn/blob/master/assets/images/dr.jpg)
+
+## Environment Overview
+
+CityLearn includes energy models of buildings and distributed energy resources (DER) including air-to-water heat pumps, electric heaters and batteries. A collection of building energy models makes up a virtual district (a.k.a neighborhood or community). In each building, space cooling, space heating and domestic hot water end-use loads may be independently satisfied through air-to-water heat pumps. Alternatively, space heating and domestic hot water loads can be satisfied through electric heaters.
+
+![Citylearn](https://github.com/intelligent-environments-lab/CityLearn/blob/master/assets/images/environment.jpg)
+
+## Installation
+Install latest release in PyPi with `pip`:
+```console
+pip install softcpsrecsimulator
+```
+
+Python import path remains:
+```python
+from citylearn.citylearn import CityLearnEnv
+```
+
+## Developer Commands
+Use the repository virtual environment when available:
+
+```console
+.venv/bin/pytest -q
+```
+
+Critical lint checks used in CI:
+
+```console
+.venv/bin/python -m ruff check citylearn tests scripts/manual scripts/ci --select E9,F821
+```
+
+Manual utility scripts live in `scripts/manual` and are excluded from default pytest collection:
+
+```console
+python scripts/manual/demo_ev_rbc.py
+python scripts/manual/demo_ev_rbc_export_end.py
+```
+
+Runtime benchmark (main training resolutions 5s/60s):
+
+```console
+python scripts/manual/bench_runtime.py --seconds 5 60 --render-modes none end --episode-steps 1200
+```
+
+CI performance smoke check command:
+
+```console
+python scripts/ci/perf_smoke.py --episode-steps 600 --seconds 60 --baseline-file scripts/ci/perf_baseline.json
+```
+
+## Publish This Fork to PyPI
+This fork is configured to publish the distribution name `softcpsrecsimulator`.
+
+1. Create the package on PyPI (project name: `softcpsrecsimulator`).
+2. In GitHub repo settings, add secret `PYPI_API_TOKEN` with a PyPI token that can publish this project.
+3. Bump `citylearn/__init__.py` version.
+4. Push commit and create a GitHub Release (or run `Publish Python Package` workflow manually).
+5. Workflow `.github/workflows/pypi_deploy.yml` builds `dist/*` and uploads to PyPI.
+
+Optional local build check:
+```console
+python -m pip install --upgrade pip build twine
+python -m build
+python -m twine check dist/*
+```
+
+## Internal Architecture
+Public APIs remain in `CityLearnEnv` and `Building`, while internal orchestration is split into service modules under `citylearn/internal`:
+
+- `loading.py`: schema-driven loading/build assembly (`_load*`, metadata processing).
+- `runtime.py`: episode runtime orchestration (`step`, action parsing, time progression, EV/charger association).
+- `building_ops.py`: building observation/action orchestration.
+- `kpi.py`: KPI/evaluation pipeline.
+
+## Export and Render Modes
+`CityLearnEnv` keeps export off by default:
+
+- `render_mode='none'`: no CSV export and minimal runtime overhead.
+- `render_mode='during'`: writes CSV rows at each environment step.
+- `render_mode='end'`: keeps the rollout fast and writes full episode CSVs when the episode ends.
+
+Optional location controls:
+
+- `render_directory`: base folder for exports.
+- `render_session_name`: session subfolder name under `render_directory` (or `render_directory_name`).
+- `render_directory_name`: legacy fallback folder under project root when `render_directory` is not set.
+- `render`: legacy boolean flag; still supported for compatibility.
+
+Examples:
+
+```python
+from citylearn.citylearn import CityLearnEnv
+
+# Fast training/no export
+env = CityLearnEnv(schema, render_mode='none')
+
+# Stream CSVs every step
+env = CityLearnEnv(
+    schema,
+    render_mode='during',
+    render_directory='outputs',
+    render_session_name='run_during'
+)
+
+# Export once at episode end
+env = CityLearnEnv(
+    schema,
+    render_mode='end',
+    render_directory='outputs',
+    render_session_name='run_end'
+)
+```
+
+## Documentation
+Refer to the [docs](https://intelligent-environments-lab.github.io/CityLearn/).
+
+## CityLearn UI
+
+CityLearn UI is a visual dashboard for exploring simulation data generated by the CityLearn framework. It was developed to simplify the analysis of results from smart energy communities, district energy coordination, demand response (among other applications), allowing users to visually inspect building-level components, compare simulation KPIs, and create simulation schemas with ease.
+
+The interface is available in two options:
+
+* Web app: https://citylearnui.netlify.app/ (free hosted version — not recommended for sensitive/personal data)
+* Open-source code: https://github.com/Soft-CPS-Research-Group/citylearn-ui
+
+You can check a tutorial at the official CityLearn [website](https://intelligent-environments-lab.github.io/CityLearn/ui.html), in the CityLearn UI repository [README](https://github.com/Soft-CPS-Research-Group/citylearn-ui), or at the help [tooltip of the oficial webapp](https://citylearn-ui.netlify.app/admin/help).
+
+**Compatibility:** This version of the UI currently supports CityLearn v2.5.0 simulation data.
+
+**Developed by:** José, a member of the [SoftCPS](https://www2.isep.ipp.pt/softcps/), Software for Cyber-Physical Systems research group (ISEP, Portugal) in collaboration with the Intelligent Environments Lab, University of Texas at Austin.

softcpsrecsimulator-0.1.0/citylearn/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'