Skip to content

Commit

Permalink
Issue #3: Adds some documentation
Browse files Browse the repository at this point in the history
- Updates the constants module documentation.
- Adds a license file.
  • Loading branch information
exoticDFT committed Feb 6, 2021
1 parent 198dc1d commit a3234ae
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
2 changes: 2 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
MIT License
===========
24 changes: 23 additions & 1 deletion script/constants_module.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
# Module to define several constants used throughout the AV stack
"""This module defines several constants used throughout the AV stack.
All values are in SI units.
Parameters
----------
MAX_ACCELERATION : float
The maximum comfortable acceleration the vehicle should experience in
normal driving situations. 3.0 [:math:`\\frac{m}{s^2}`]
MAX_DECELERATION : 9.0 [:math:`\\frac{m}{s^2}`]
The maximum deceleration the vehicle should experience when in emergency
situations.
MAX_JERK : 1.3 [:math:`\\frac{m}{s^3}`]
The maximum jerk the vehicle should experience in normal driving
situations.
FREEFLOW_SPEED : 1.0 [:math:`\\frac{1}{s}`]
The proportional constant when in freeflow driving scenarios (car
following).
MODE_NORMAL : 0
Mode representing the vehicle when in normal driving situations.
MODE_EMERGENCY : 1
Mode representing the vehicle when in emergency driving situations.
"""
MAX_ACCELERATION = 3.0 # [m/s^2] (positive)
MAX_DECELERATION = 9.0 # [m/s^2] (positive)
MAX_JERK = 1.3 # [m/s^3] (positive)
Expand Down

0 comments on commit a3234ae

Please sign in to comment.