Setup Instructions

1. Install pyenv:

   First, install pyenv to manage Python versions:

   # On macOS
   brew install pyenv
   
   # On Linux
   curl https://pyenv.run | bash

   Add pyenv to your shell configuration file (e.g., .bashrc, .zshrc):

   echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
   echo 'command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
   echo 'eval "$(pyenv init -)"' >> ~/.bashrc

   Restart your shell or run source ~/.bashrc (or your appropriate shell config file).

2. Install Python using pyenv:

   pyenv install 3.x.x  # Replace x.x with the desired Python version
   pyenv global 3.x.x

3. Clone the repository:

   git clone https://github.com/voxmenthe/repo_name.git
   cd repo_name

4. Create a virtual environment:

   python3 -m venv venv
   source venv/bin/activate

5. Install the dependencies:

   pip install -r requirements.txt

6. Install the package:

   pip install -e .

7. Running Jupyter Notebooks:

   Ensure that your Jupyter Notebook is using the virtual environment's Python interpreter. You can set it up by running:

   python -m ipykernel install --user --name=repo_name

   Then, select repo_name as the kernel in Jupyter Notebook.