Metadata-Version: 2.1
Name: leads
Version: 0.0.1
Summary: Lightweight Embedded Assisted Driving System
Home-page: https://github.com/ProjectNeura/LEADS
Author: ProjectNeura
Author-email: central@projectneura.org
License: Apache License 2.0
Description-Content-Type: text/markdown
License-File: LICENSE

# LEADS: Lightweight Embedded Assisted Driving System

LEADS is a system designed for VeC.

LEADS only supports two-wheel configurations: single rear wheel (SRW) mode and dual rear wheel (DRW) mode.

Python is generally not the best choice for writing embedded systems. We made this decision for the following reasons.

- Data analysis
- Short development cycle
- Official support for Raspberry Pi
- Low difficulty in getting started for team members

This project aims to implement the following functions:

- A basic instrumentation system
- A basic control system
- A basic communication system
- A speed recording system
- A G force recording system
- DTCS (Dynamic Traction Control System)
- ABS (Anti-lock Braking System)
- EBI (Emergency Braking Intervention)
- ATBS (Automatic Trail Braking System)

## Periodic Report

See [reports](https://github.com/ProjectNeura/LEADS/tree/master/reports).

## Collaborations

### Community

#### Issues

Our team management completely relies on GitHub. Tasks are published and assigned
as [issues](https://github.com/ProjectNeura/LEADS/issues). You will be notified if
you are assigned to certain tasks. However, you may also choose to join other
discussions for which you are not responsible.

There are a few labels that classify the issues.

- `bug` reports a bug
- `code review` discusses a code review or comment
- `documentation` suggests a documentation enhancement
- `duplicate` marks that a similar issue has been raised
- `enhancement` proposes a new feature or request
- `help wanted` means that extra attention is needed to this issue
- `invalid` marks that the issue is in valid format
- `question` requests further information
- `report` starts a periodic report discussion
- `todo` creates a new task
- `wontfix` marks that the issue is ignored

Label your issue with at least one of the labels above before you submit.

#### Projects

You can have a look on the whole schedule of each project in timeline using the
[projects](https://github.com/orgs/ProjectNeura/projects/) feature.

### Code Contributions

Please fork the project into your own repository. Before your pull request, make
sure that you have tested all possible impacts on other parts of the project.
If no certainty is assured, please reach out to our core team members to have
official supports.
