Prepare upstream publish metadata for CityLearn 2.6.0b1

Author: calofonseca

.github/workflows/pypi_deploy.yml

@@ -1,54 +1,33 @@
-name: Publish Python Package
+name: Upload Python Package
 
 on:
   workflow_dispatch:
   release:
     types: [published]
 
 jobs:
-  build:
+  deploy:
+  
+    environment: pypi 
     runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: [3.11]
 
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
         with:
-          python-version: "3.11"
-
+          python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install build twine
-
-      - name: Build distributions
+          pip install setuptools wheel twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
         run: |
-          python -m build
-          python -m twine check dist/*
-
-      - name: Upload package artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: python-dist
-          path: dist/
-
-  publish:
-    needs: build
-    runs-on: ubuntu-24.04
-    environment:
-      name: pypi
-      url: https://pypi.org/project/softcpsrecsimulator/
-
-    steps:
-      - name: Download package artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: python-dist
-          path: dist/
-
-      - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          password: ${{ secrets.PYPI_API_TOKEN }}
+          python setup.py sdist bdist_wheel
+          twine upload --verbose dist/*

MANIFEST.in

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

PYPI_RELEASE.md

@@ -12,107 +12,7 @@ CityLearn includes energy models of buildings and distributed energy resources (
 ## 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'
-)
+pip install CityLearn
 ```
 
 ## Documentation

README.md

@@ -1 +1 @@
-__version__ = '0.2.1'
+__version__ = '2.6.0b1'

README_PYPI.md

@@ -34,8 +34,8 @@ def get_settings():
 class DataSet:
     """CityLearn input data set and schema class."""
 
-    GITHUB_ACCOUNT = os.getenv('CITYLEARN_DATASET_GITHUB_ACCOUNT', 'Soft-CPS-Research-Group')
-    REPOSITORY_NAME = os.getenv('CITYLEARN_DATASET_REPOSITORY', 'Simulator')
+    GITHUB_ACCOUNT = os.getenv('CITYLEARN_DATASET_GITHUB_ACCOUNT', 'intelligent-environments-lab')
+    REPOSITORY_NAME = os.getenv('CITYLEARN_DATASET_REPOSITORY', 'CityLearn')
     REPOSITORY_TAG = os.getenv('CITYLEARN_DATASET_TAG', f'v{__version__}')
     REPOSITORY_DATA_PATH = FileHandler.join_url('data')
     REPOSITORY_DATA_DATASETS_PATH = FileHandler.join_url(REPOSITORY_DATA_PATH, 'datasets')

citylearn/__init__.py

@@ -4,15 +4,11 @@
 
 ROOT = os.path.dirname(__file__)
 VERSION_RE = re.compile(r"__version__\s*=\s*['\"]([\w\.-]+)['\"]")
-DIST_NAME = os.getenv('CITYLEARN_PYPI_NAME', 'softcpsrecsimulator')
-PYPI_README = os.path.join(ROOT, 'README_PYPI.md')
 
-readme_path = PYPI_README if os.path.exists(PYPI_README) else os.path.join(ROOT, 'README.md')
-
-with open(readme_path, 'r', encoding='utf-8') as fh:
+with open('README.md', 'r') as fh:
     long_description = fh.read()
 
-with open('requirements.txt', 'r', encoding='utf-8') as fh:
+with open('requirements.txt', 'r') as fh:
    requirements = fh.readlines()
    requirements = [requirement.strip().replace('\n','').replace('\r','') for requirement in requirements]
    requirements = [requirement for requirement in requirements if len(requirement) != 0 and requirement[0] != '#']
@@ -22,25 +18,20 @@ def get_version():
     return VERSION_RE.search(init).group(1)
 
 setuptools.setup(
-    name=DIST_NAME,
+    name='citylearn',
     version=get_version(),
-    author='Soft-CPS Research Group, Jose Ramon Vazquez-Canteli, Kingsley Nweye, Zoltan Nagy',
-    author_email='jose@isep.ipp.pt',
+    author='Jose Ramon Vazquez-Canteli, Kingsley Nweye, Zoltan Nagy',
+    author_email='nweye@utexas.edu',
     description=(
-        'SoftCPS REC Simulator: an energy-community RL simulator fork focused on EV/BESS/PV, '
-        'electrical-service constraints, and community-market experimentation.'),
+        'An open source Farama Foundation Gymnasium environment for benchmarking distributed '
+        'energy resource control algorithms to provide energy flexibility in a district of buildings.'),
     long_description=long_description,
     long_description_content_type='text/markdown',
-    url='https://github.com/Soft-CPS-Research-Group/Simulator',
-    license='MIT',
+    url='https://github.com/intelligent-environments-lab/CityLearn',
     packages=setuptools.find_packages(),
     include_package_data=True,
     install_requires=requirements,
     entry_points={'console_scripts': ['citylearn = citylearn.__main__:main']},
-    project_urls={
-        'Source': 'https://github.com/Soft-CPS-Research-Group/Simulator',
-        'Original Project': 'https://github.com/intelligent-environments-lab/CityLearn',
-    },
     classifiers=[
         'Programming Language :: Python :: 3',
         'License :: OSI Approved :: MIT License',