SRILab-Parked-Cars-Road-Classification

Prerequisites

Before you can run this project, you need to have the following installed on your machine:

• Git
• Python 3.10
• 'pipenv' package manager

Installation

To install this project, follow these steps:

1. Clone the repository:

git clone https://github.com/cjunwon/SRILab-Parked-Cars-Road-Classification

2. Navigate to the project directory

cd SRILab-Parked-Cars-Road-Classification

3. Install pipenv:

pip install pipenv

4. Install required packages:

pipenv install

5. Activate the virtual environment:

pipenv shell

Contributing

If you are contributing to this project, please follow these steps:

1. Fork the repository:
   To fork this project, click the "Fork" button in the top-right corner of the GitHub page or click here.

Configure this remote repository for a fork (set upstream). Documentation can be found here.

2. Create a new branch:

git checkout -b my-new-branch

Note for contributers (SRILab Team members):
For initial test code, we can just commit directly to the main branch with .ipynb files named after each team member.

3. Navigate to the project directory

cd SRILab-Parked-Cars-Road-Classification

4. Install pipenv:

pip install pipenv

5. Install required packages:

pipenv install

6. Activate the virtual environment:

pipenv shell

Note for contributers (SRILab Team members):
Make sure to run 'pipenv lock' after you 'pipenv install' any new packages.

7. Make your changes and commit them:

git commit -m 'Add new feature'

8. Push your changes to your fork:

git push origin my-new-feature

9. Create a pull request.

Note for contributers (SRILab Team members):
If you are working with an ipynb file, make sure the kernal is set to the project's pipenv.