Project Onboarding Steps

Follow these steps to set up your development environment for the project.

Step 1: Install Python 3.7

Python 3.7 is required for this project. Download and install it from the official Python website.

For Windows:

Download from https://www.python.org/downloads/release/python-370/ Follow the installer steps

For macOS and Linux:

Install Python 3.7 using Homebrew (macOS) or a package manager of your choice (Linux)

 brew install python@3.7

Step 2: Install Jupyter Notebook

Jupyter Notebook is necessary for running and testing notebook files. Install Jupyter Notebook using pip

    pip install jupyter

Step 3: Install Pyenv

Pyenv is used to manage multiple Python versions. Install pyenv. Visit https://github.com/pyenv/pyenv#installation for detailed installation instructions.

For macOS:

    brew install pyenv

For Linux:

    sudo apt install -y make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev
    curl https://pyenv.run | bash

if you are using bash

    echo -e 'export PYENV_ROOT="$HOME/.pyenv"\nexport PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
    echo -e 'eval "$(pyenv init --path)"\neval "$(pyenv init -)"' >> ~/.bashrc

if you are using zsh

    echo -e 'export PYENV_ROOT="$HOME/.pyenv"\nexport PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zshrc
    echo -e 'eval "$(pyenv init --path)"\neval "$(pyenv init -)"' >> ~/.zshrc

Restart your terminal and check if pyenv is installed

    exec "$SHELL"
    pyenv --version

Step 4: Create a Virtual Environment

Create a virtual environment to manage the project's dependencies separately. Create a virtual environment using Python 3.7

    pyenv install 3.11.9
    pyenv virtualenv 3.11.9 chest_xray_env

Step 5: Install Required Libraries

Activate your virtual environment and install the required libraries.

    pyenv activate chest_xray_env
    pip install -r requirements.txt

Possible Errors

Error 1: `command not found: pyenv`

Solution: Add the following line to your shell configuration file (e.g., ~/.bashrc, ~/.bash_profile, or ~/.zshrc)

    export PATH="$HOME/.pyenv/bin:$PATH"
    eval "$(pyenv init -)"
    eval "$(pyenv virtualenv-init -)"

Error 2: ModuleNotFoundError: No module named '_ctypes'

Solution: Install the required library using the following command and try again.

upgrade your system

    sudo apt-get update
    sudo apt-get upgrade

install the required library

    sudo apt-get install libffi-dev

recompile python

    pyenv uninstall 3.11.9
    pyenv install 3.11.9

sanlamamba/zoidberg-pneumonia