getting_started.md

Getting Started

Prerequisites

• Python 3.8 or higher
• pip
• virtualenv

Setup

1. Clone the repository

git clone https://github.com/DallasFormulaRacing/PowertrainLib

2. Navigate to the root directory of the repository

cd PowertrainLib

3. Create a virtual environment

python -m venv venv

4. Activate the virtual environment (Windows)

.\venv\Scripts\activate

5. Install the required packages

pip install -r requirements.txt

6. Enter the dashboard directory

cd dashboard

7. Run the dashboard

python app.py

Dashboard File Structure

+-- Assets/
      |      +-- css
      |      +-- images
      |      +-- scripts

+-- Components/
      |      +-- footer
      |      +-- navbar
      |      +-- etc.
+-- Pages/
      |      +-- 404.py
      |      +-- aero.py
      |      +-- steeringsuspension.py
      |      +-- powertrain/
                      |      +-- visualizations/
                                    |     +-- rpm_over_time.py
                      |      +-- layout.py
+-- Utils/
      |      +-- common functions
+-- app.py