Optimization Hackathon Team Setup

Welcome to the repo! short instructions on how to setup the repo

Prerequisites

• Python 3.8+ installed
• Git installed

Windows Setup Instructions

1. Clone the repository Open your terminal and clone this repo to your machine: git clone https://github.com/VP1701/koja_hackathon.git cd koja_hackathon

2. Create the virtual environment python -m venv venv

3. Activate the virtual environment Run this command to enter the environment. You need to do this every time you open a new terminal to work on this project! venv\Scripts\activate (You will know it worked if you see (venv) next to your command prompt.)

4. Install all project libraries This will install NumPy, PyTorch, GPyTorch, scikit-learn, and our other tools exactly as they were set up originally. pip install -r requirements.txt

Working with Branches

1. Create and switch to a new branch git checkout -b <your-branch-name>

2. Check your current branch If you ever forget which branch you are on, run this: git branch

3. Push your new branch to the remote repository The very first time you push code from a newly created branch, you need to tell Git to track it upstream: git push -u origin <your-branch-name> (For all future pushes on this branch, you can just type git push.)

4. Switch back to the main branch When you are done or need to pull the latest team updates: git checkout main (Note: depending on how our repo initialized, our primary branch might be named master instead of main.)

Adding New Libraries

If you need to install a new library during the hackathon, please do the following so the rest of the team gets it:

1. Make sure your environment is active.
2. Run pip install <library-name>
3. Run pip freeze > requirements.txt
4. Commit the updated requirements.txt file to Git.