champpy 0.1.0__tar.gz

champpy-0.1.0/.gitattributes

@@ -0,0 +1,3 @@
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.svg filter=lfs diff=lfs merge=lfs -text
+data/**/*.svg -filter -diff -merge text

champpy-0.1.0/.github/workflows/deploy.yml

@@ -0,0 +1,17 @@
+name: Deploy
+
+# TODO: Configure deployment workflow
+# This workflow will be used to deploy the package to PyPI or other platforms
+
+on:
+  workflow_dispatch:
+
+jobs:
+  noop:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Skip deployment (not configured)
+        run: echo "Deploy workflow not configured yet."
+
+
+

champpy-0.1.0/.github/workflows/lint.yml

@@ -0,0 +1,42 @@
+name: Lint
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+  black:
+    name: Black Code Formatter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+      
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      
+      - name: Run Black
+        run: black -l 120 --check ./src/champpy/ ./tests/ ./scripts/
+
+  flake8:
+    name: Flake8 Linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+      
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      
+      - name: Run Flake8
+        run: flake8 --max-line-length=120 --ignore=E501,E712,E203,W503,W291,W293 ./src/champpy/ ./tests/ ./scripts/

champpy-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,65 @@
+name: Publish to PyPI
+
+on:
+  workflow_run:
+    workflows: ["Tests"]
+    types: [completed]
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success'
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event_name == 'workflow_run' && github.event.workflow_run.head_sha || github.sha }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install build tools
+        run: python -m pip install --upgrade build twine
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Check distribution metadata
+        run: python -m twine check dist/*
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: build
+
+    permissions:
+      id-token: write
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/champpy
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-dist
+          path: dist/
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

champpy-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,33 @@
+name: Tests
+
+on:
+  workflow_run:
+    workflows: ["Lint"]
+    types: [completed]
+    branches: ["**"]
+  workflow_dispatch:
+
+jobs:
+  tests:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success'
+    strategy:
+      matrix:
+        python-version: ["3.11","3.12","3.13"]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event_name == 'workflow_run' && github.event.workflow_run.head_sha || github.sha }}
+          lfs: true
+      
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      
+      - name: Run Tests
+        run: pytest tests/ -v

champpy-0.1.0/.gitignore

@@ -0,0 +1,48 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+
+# Virtual environments
+.venv/
+env/
+venv/
+ENV/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Generated files
+*.html
+dist/
+build/
+*.egg-info/
+
+# Testing
+.pytest_cache/
+.hypothesis/
+.coverage
+htmlcov/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Data and output
+data/*
+!data/graphical_abstract.svg
+!data/example1/
+!data/example1/**
+!data/example2/
+!data/example2/**
+plots/*.html
+
+# Docs
+docs/_build/
+docs/notebooks/*.ipynb

champpy-0.1.0/.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

champpy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 FfE Munich
+
+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.

champpy-0.1.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: champpy
+Version: 0.1.0
+Summary: CHAMPPy - Mobility and Charging Profiles
+Project-URL: Repository, https://github.com/ffe-munich/CHAMPPy
+Project-URL: Issues, https://github.com/ffe-munich/CHAMPPy/issues
+Author-email: Florian Biedenbach <fbiedenbach@ffe.de>
+License: MIT
+License-File: LICENSE
+Keywords: charging,electric vehicles,markov,mobility,profiles
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Requires-Dist: numpy>=1.0
+Requires-Dist: pandas>=1.0
+Requires-Dist: pandera[strategies]>=0.15
+Requires-Dist: plotly>=5.0
+Requires-Dist: pyarrow
+Requires-Dist: pydantic>=2.0
+Requires-Dist: rich>=13.0
+Requires-Dist: scipy>=1.7
+Requires-Dist: tqdm>=4.0
+Provides-Extra: dev
+Requires-Dist: black>=22.0; extra == 'dev'
+Requires-Dist: flake8>=4.0; extra == 'dev'
+Requires-Dist: jupyter>=1.0; extra == 'dev'
+Requires-Dist: nbconvert>=7.0; extra == 'dev'
+Requires-Dist: pylint>=2.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2024.0; extra == 'docs'
+Requires-Dist: myst-nb>=1.0; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints>=2.0; extra == 'docs'
+Requires-Dist: sphinx-copybutton>=0.5.0; extra == 'docs'
+Requires-Dist: sphinx>=9.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# CHAMPPy
+
+<!-- TODO: Add Badges from https://img.shields.io -->
+
+CHAMPPy (Charging and Mobility Profiles in Python) is a Python library to generate synthetic mobility and charging profiles for different types of electric vehicles including vans, trucks, busses and passanger cars. 
+
+<p align="center">
+   <img src="data/graphical_abstract.svg" width="80%" alt="Graphical Abstract">
+</p>
+
+Road transport decarbonization requires realistic charging demand models across all vehicle classes. However, many existing studies and publicly available tools focus mainly on private passenger cars, while commercial electric vehicles such as vans and trucks are often underrepresented despite their major relevance for emissions and grid impacts. CHAMPPy is an open Python package that addresses this gap by generating synthetic driving and charging profiles for different EV types, including commercial fleets. The model combines a Markov chain to represent vehicle locations over time with beta-distributed journey speeds, from which trip distances are derived, and uses dedicated algorithms to generate mobility and charging behavior. An optional clustering approach increases profile heterogeneity and is particularly useful when analyzing individual profiles.
+
+CHAMPPy supports two workflows:
+
+1. Use existing parameters to quickly generate drving and charging profiles with user-defined settings (e.g., simulation period, number of vehicles, charging power, battery capacity).
+2. Re-parameterize the model with custom reference data (e.g., other countries, fleet compositions, or vehicle classes). Generate drving and charging profiles from your model parameters.
+
+## Links
+
+* Documentation: TODO
+* Source code: [https://github.com/ffe-munich/CHAMPPy](https://github.com/ffe-munich/CHAMPPy)
+* PyPI releases: TODO
+* License: [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
+
+## Authors
+
+CHAMPPy has been developed by [Florian Biedenbach](https://github.com/FloBieWan) (lead), Valentin Preis und [Daniel Godin](https://github.com/DaniGodin).
+
+## Repo structure
+
+```
+CHAMPPy/
+├── src/champpy/                        # Main package source code
+│   ├── __init__.py
+│   ├── core/                           # Core functionality
+│   │   ├── __init__.py
+│   │   ├── charging/                   # Charging profile module
+│   │   │   ├── __init__.py
+│   │   │   ├── charging_model.py       # Model to generate charging profiles
+│   │   │   └── charging_validation.py  # Charging validation & plotting
+│   │   └── mobility/                   # Mobility profile module
+│   │       ├── __init__.py
+│   │       ├── mobility_cleaning.py    # Data cleaning
+│   │       ├── mobility_components.py  # Data components
+│   │       ├── mobility_data.py        # Data structures
+│   │       ├── mobility_model.py       # Model to generate profiles
+│   │       ├── mobility_validation.py  # Validation & plotting
+│   │       └── parameterization.py     # Parameter extraction
+│   ├── utils/                          # Utilities
+│   │   ├── __init__.py
+│   │   ├── data_utils.py               # Ddata helpers
+│   │   ├── logging.py                  # Logging configuration
+│   │   └── time_utils.py               # Time utilities
+|   └── data/                       
+│       ├── params_info.parquet         # Info about existing model parameters
+│       └── params.parquet              # Existing model parameters
+├── notebooks/                          # Jupyter notebooks
+│   ├── 01_demo_without_parameterization.ipynb # Demo notebook 1
+│   └── 02_demo_including_parameterization.ipynb # Demo notebook 2
+├── scripts/                            # Python scripts
+├── tests/                              # Test suite
+├── data/                               # Data directory
+├── plots/                              # Generated plots (HTML files)
+├── pyproject.toml                      # Project configuration
+├── LICENSE                             # License file
+└──  README.md                          # This file
+```
+
+## Installation
+
+<!-- docs-installation-start -->
+
+### Prerequisites
+- Python 3.11 or higher
+- pip
+
+### Install from source
+
+```bash
+# Clone the repository
+git clone https://github.com/ffe-munich/CHAMPPy.git
+cd CHAMPPy
+
+# Create a virtual environment
+python -m venv .venv
+
+# Activate virtual environment
+# On Windows:
+.\.venv\Scripts\activate
+# On Linux/Mac:
+source .venv/bin/activate
+
+# Install the package in development mode
+pip install .
+```
+
+### Install from PyPI
+
+```bash
+# Create a virtual environment
+python -m venv .venv
+
+# Activate virtual environment
+# On Windows:
+.\.venv\Scripts\activate
+# On Linux/Mac:
+source .venv/bin/activate
+
+pip install champpy
+```
+<!-- docs-installation-end -->
+
+<!-- sphinx-exclude-start -->
+## Examples
+
+For detailed examples, check out the interactive Jupyter notebooks in the `notebooks/` directory:
+
+1. **[01_demo_without_parameterization.ipynb](notebooks/01_demo_without_parameterization.ipynb)**  
+   Simple demo showing how to generate mobility and charging profiles using existing model parameters.
+
+2. **[02_demo_including_parameterization.ipynb](notebooks/02_demo_including_parameterization.ipynb)**  
+   Complete workflow including parameterization from raw data, model generation, and validation.
+<!-- sphinx-exclude-end -->
+
+
+
+
+

champpy-0.1.0/README.md

@@ -0,0 +1,128 @@
+# CHAMPPy
+
+<!-- TODO: Add Badges from https://img.shields.io -->
+
+CHAMPPy (Charging and Mobility Profiles in Python) is a Python library to generate synthetic mobility and charging profiles for different types of electric vehicles including vans, trucks, busses and passanger cars. 
+
+<p align="center">
+   <img src="data/graphical_abstract.svg" width="80%" alt="Graphical Abstract">
+</p>
+
+Road transport decarbonization requires realistic charging demand models across all vehicle classes. However, many existing studies and publicly available tools focus mainly on private passenger cars, while commercial electric vehicles such as vans and trucks are often underrepresented despite their major relevance for emissions and grid impacts. CHAMPPy is an open Python package that addresses this gap by generating synthetic driving and charging profiles for different EV types, including commercial fleets. The model combines a Markov chain to represent vehicle locations over time with beta-distributed journey speeds, from which trip distances are derived, and uses dedicated algorithms to generate mobility and charging behavior. An optional clustering approach increases profile heterogeneity and is particularly useful when analyzing individual profiles.
+
+CHAMPPy supports two workflows:
+
+1. Use existing parameters to quickly generate drving and charging profiles with user-defined settings (e.g., simulation period, number of vehicles, charging power, battery capacity).
+2. Re-parameterize the model with custom reference data (e.g., other countries, fleet compositions, or vehicle classes). Generate drving and charging profiles from your model parameters.
+
+## Links
+
+* Documentation: TODO
+* Source code: [https://github.com/ffe-munich/CHAMPPy](https://github.com/ffe-munich/CHAMPPy)
+* PyPI releases: TODO
+* License: [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
+
+## Authors
+
+CHAMPPy has been developed by [Florian Biedenbach](https://github.com/FloBieWan) (lead), Valentin Preis und [Daniel Godin](https://github.com/DaniGodin).
+
+## Repo structure
+
+```
+CHAMPPy/
+├── src/champpy/                        # Main package source code
+│   ├── __init__.py
+│   ├── core/                           # Core functionality
+│   │   ├── __init__.py
+│   │   ├── charging/                   # Charging profile module
+│   │   │   ├── __init__.py
+│   │   │   ├── charging_model.py       # Model to generate charging profiles
+│   │   │   └── charging_validation.py  # Charging validation & plotting
+│   │   └── mobility/                   # Mobility profile module
+│   │       ├── __init__.py
+│   │       ├── mobility_cleaning.py    # Data cleaning
+│   │       ├── mobility_components.py  # Data components
+│   │       ├── mobility_data.py        # Data structures
+│   │       ├── mobility_model.py       # Model to generate profiles
+│   │       ├── mobility_validation.py  # Validation & plotting
+│   │       └── parameterization.py     # Parameter extraction
+│   ├── utils/                          # Utilities
+│   │   ├── __init__.py
+│   │   ├── data_utils.py               # Ddata helpers
+│   │   ├── logging.py                  # Logging configuration
+│   │   └── time_utils.py               # Time utilities
+|   └── data/                       
+│       ├── params_info.parquet         # Info about existing model parameters
+│       └── params.parquet              # Existing model parameters
+├── notebooks/                          # Jupyter notebooks
+│   ├── 01_demo_without_parameterization.ipynb # Demo notebook 1
+│   └── 02_demo_including_parameterization.ipynb # Demo notebook 2
+├── scripts/                            # Python scripts
+├── tests/                              # Test suite
+├── data/                               # Data directory
+├── plots/                              # Generated plots (HTML files)
+├── pyproject.toml                      # Project configuration
+├── LICENSE                             # License file
+└──  README.md                          # This file
+```
+
+## Installation
+
+<!-- docs-installation-start -->
+
+### Prerequisites
+- Python 3.11 or higher
+- pip
+
+### Install from source
+
+```bash
+# Clone the repository
+git clone https://github.com/ffe-munich/CHAMPPy.git
+cd CHAMPPy
+
+# Create a virtual environment
+python -m venv .venv
+
+# Activate virtual environment
+# On Windows:
+.\.venv\Scripts\activate
+# On Linux/Mac:
+source .venv/bin/activate
+
+# Install the package in development mode
+pip install .
+```
+
+### Install from PyPI
+
+```bash
+# Create a virtual environment
+python -m venv .venv
+
+# Activate virtual environment
+# On Windows:
+.\.venv\Scripts\activate
+# On Linux/Mac:
+source .venv/bin/activate
+
+pip install champpy
+```
+<!-- docs-installation-end -->
+
+<!-- sphinx-exclude-start -->
+## Examples
+
+For detailed examples, check out the interactive Jupyter notebooks in the `notebooks/` directory:
+
+1. **[01_demo_without_parameterization.ipynb](notebooks/01_demo_without_parameterization.ipynb)**  
+   Simple demo showing how to generate mobility and charging profiles using existing model parameters.
+
+2. **[02_demo_including_parameterization.ipynb](notebooks/02_demo_including_parameterization.ipynb)**  
+   Complete workflow including parameterization from raw data, model generation, and validation.
+<!-- sphinx-exclude-end -->
+
+
+
+
+