Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 3.27 KB

README_en.md

File metadata and controls

86 lines (62 loc) · 3.27 KB
Raw

Automated driving algorithms

Python codes for automated driving algorithms.

简体中文 | English

GitHub Repo stars License

Poetry Code style: black Ruff Checked with mypy

How to use

1. Get source code

  1. Add star to this repo if you like it 😃
  2. Get source code by one of the following methods
    • Download code zip
    • (For development only) clone repo git clone https://github.com/muziing/PythonAutomatedDriving.git
  3. Go to the project directory cd /your/path/to/PythonAutomatedDriving

2. Creating Virtual Environment and Install requirements

Option A: venv & pip

  1. Ensure that the Python version matches the one required in pyproject.toml.
  2. Create virtual environment
    • Windows: python -m venv --upgrade-deps venv
    • Linux/macOS: python3 -m venv --upgrade-deps venv
  3. Activate virtual environment
    • Windows: venv\Scripts\activate
    • Linux/macOS: . venv/bin/activate
  4. Install the requirements pip install -r requirements.txt

Option B: Poetry

  1. Make sure the Python version is the same as required in pyproject.toml.
  2. Install Poetry as instructed in the official documentation.
  3. Create a virtual environment: poetry env use /full/path/to/python
  4. Install dependencies: poetry install --no-dev
  5. Use the virtual environment: poetry shell (or configure it in an IDE like PyCharm).

Option C: Anaconda

conda env create -f environment.yml

3. Run!

Execute Python script in each directory.

Table of Contents

AuxiliaryFunctions

LocalPathPlanning

License

Copyright 2022-2023 muzing

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.