Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/Book.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
- name: Setup python
uses: actions/setup-python@v7
with:
python-version: '3.13'
python-version: '3.14'

- name: Install dependencies
run: |
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/Linux_CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.13']
# See "Supported Python versions" in HOWTOCONTRIBUTE.md.
python-version: ['3.11', '3.12', '3.13', '3.14', '3.15']

name: Python ${{ matrix.python-version }} CI

Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/MacOS_CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ jobs:
runs-on: macos-latest
strategy:
matrix:
python-version: [ '3.13' ]
# See "Supported Python versions" in HOWTOCONTRIBUTE.md.
python-version: [ '3.11', '3.12', '3.13', '3.14', '3.15' ]
name: Python ${{ matrix.python-version }} CI
steps:
- uses: actions/checkout@v7
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/Update_Examples_Gallery.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- name: Setup python
uses: actions/setup-python@v7
with:
python-version: '3.13'
python-version: '3.14'

# The script uses only the standard library, so no dependency install is needed
- name: Generate examples gallery
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/Windows_CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ jobs:
runs-on: windows-latest
strategy:
matrix:
python-version: ['3.13']
# See "Supported Python versions" in HOWTOCONTRIBUTE.md.
python-version: ['3.11', '3.12', '3.13', '3.14', '3.15']

name: Python ${{ matrix.python-version }} CI

Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM python:3.13.0
FROM python:3.14

ARG DEBIAN_FRONTEND=noninteractive

Expand Down
34 changes: 34 additions & 0 deletions HOWTOCONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,40 @@ Before starting your contribution, please check [README](/README.md) to understa
If you use an AI coding tool such as Claude Code, the project's conventions are summarized in [CLAUDE.md](/CLAUDE.md), which Claude Code loads automatically.
For questions and ideas, please use [Discussions](https://github.com/ShisatoYano/AutonomousVehicleControlBeginnersGuide/discussions). Issues are for bug reports and agreed tasks.

## Supported Python versions

The project supports every Python version that has not reached its end of life,
so learners can use the interpreter that ships with their OS. The Linux, macOS
and Windows CI workflows run the test suite on every supported version.

| Role | Version | Used by |
|---|---|---|
| Newest supported | 3.15 | CI matrix |
| Recommended | 3.14 | README, Dockerfile, dev container, book and gallery workflows |
| Oldest supported | 3.11 | CI matrix |

The recommended version is the newest release minus one. A new Python version is
not recommended right after its release because the dependencies (NumPy, SciPy,
matplotlib, CasADi, do-mpc) may not have wheels for it yet. The Dockerfile names
the minor version without a patch number (`python:3.14`), so rebuilding the image
also picks up patch and security fixes.

"Supported" means the code runs and the test suite passes on that version. It
does not mean every dependency publishes wheels for it: pip installs the newest
release of each dependency that still supports the interpreter, so Python 3.11
gets older NumPy and SciPy releases than Python 3.15.

### Yearly review

Review the policy every year in December or January, after the October Python
release:

1. Add the new version to the CI matrix once its dependencies publish wheels.
If one of them does not, leave the version out and add a comment in the
workflow saying which dependency blocks it.
2. Move the recommended version up by one, and update the files in the table.
3. Remove versions that reached their end of life from the matrix and the table.

## Add new sample program of algorithm
Steps to add a new sample program.

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Beyond single algorithms, the project shows how they work together: how the stag
## Requirements
Please satisfy with the following requirements on native or VM Linux in advance.
For running each sample codes:
* [Python 3.13.x](https://www.python.org/)
* [Python 3.14.x](https://www.python.org/)
* [Matplotlib](https://matplotlib.org/)
* [NumPy](https://numpy.org/)
* [SciPy](https://scipy.org/)
Expand Down Expand Up @@ -93,7 +93,7 @@ Note for options A and B: The container shows the animations through your host's


#### C. Local (without Docker)
1. Install [Python 3.13.x](https://www.python.org/)
1. Install [Python 3.14.x](https://www.python.org/)
2. Create a virtual environment and install the required libraries
* Linux / macOS:
```bash
Expand Down
2 changes: 1 addition & 1 deletion doc/ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ The package is also meant to be imported by other projects, not only by the simu

Drawing dependencies (matplotlib, Pillow) and MPC dependencies (CasADi, do-mpc) are optional extras (`pip install <package>[viz]`, `[mpc]`). Each component is split when its stage is ported in Phase 2, not in one big rewrite, so open pull requests are affected as little as possible. Until Phase 2 is done the API can change between versions (0.x). A stable release on PyPI follows after it. The library is for learning, research and prototyping. It is pure Python and not meant for real-time control of real vehicles.

The public API of the core has type hints for every argument and return value, the package ships a `py.typed` marker, and CI type-checks the core modules with pyright.
The public API of the core has type hints for every argument and return value, the package ships a `py.typed` marker, and CI type-checks the core modules with pyright. Supported Python versions and the yearly review that updates them are defined in [HOWTOCONTRIBUTE.md](https://github.com/ShisatoYano/AutonomousVehicleControlBeginnersGuide/blob/main/HOWTOCONTRIBUTE.md#supported-python-versions).

## Roadmap

Expand Down