hspr's Introduction

Headlamp Systems Performance Rating

Disclaimer

This is an early version of the HSPR software. The code base is work in progress and a refactoring of the code is coming soon. All computations are based on Headlight Safety Performance Rating (HSPR) - Recommended Practice - CE-5815. For further instructions of how to use the software, see Software Manual.

Starting the program

The easiest way to use the HSPR software is via this download link or the Downloadlink file located in this repository. This leads to an already provided executable program for Windows operating systems. Alternatively and for other operating systems than Windows please follow the further installation instructions.

Installation

Currently we used and tested the software for Python 3.11.4
We recommend using an Virtual Python Environment like miniconda. To create a new conda environment run the following command in the command line terminal
```
conda create -n EnvironmentName python==3.11.4
conda activate EnvironmentName # activate the environment
```
Please use the provided zip file or clone the repository using the following command in your command line:
```
    git clone https://github.com/HSPR-Software/HSPR.git
```
- To use the git clone command under windows pleas install the latest git software
To install the required python packages please run the following command from the main directory of the project (conda environment needs to be activated)
```
pip install -r requirements.txt # file is located in the base folder
```
To run the program you can use the following command:
```
python src/main.py
```
To create an executable file for your operating system please run the following command inside the directory:
```
pyinstaller HSPR.spec
```
The .spec is a predefined build configuration. The file will be located inside the src/dist folder after completion of the process.

hspr's People