Setting up local environment for repo

Setup Python Environment

for Debian based OS

sudo apt-get install -y python3.9
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3.9 get-pip.py --user
python3.9 -m pip install virtualenv --user
python3.9 -m virtualenv walle
. walle/bin/activate

for MacOS

https://www.python.org/downloads/release/python-3913/

python3.9 -m pip install --upgrade pip
python3.9 -m pip install virtualenv
python3.9 -m virtualenv walle
. walle/bin/activate

for Windows

open to anyone to make a PR adding this section

2. Setup and run Wall-E

If you encounter any errors doing the following commands, feel free to add it to the FAQs section for future reference :)

Pre-requisites: git

If you have not cloned your forked version yet
wget https://raw.githubusercontent.com/CSSS/wall_e/master/download_repo.sh
./download_repo.sh

If you have forked your version
./run_walle.sh

Setting up IDE

I strongly recommend using PyCharm. You are free to use VS Code or some other text editor but this repo is a bit too expansive for just a text editor imo.

Setting up Interpreter

Once you have opened the repo in PyCharm, You first need to setup the interpreter point it to the virtual environment you setup above.

Setting up Run Configuration

You can do this by clicking on the small dropdown menu there [red box] and then clicking on Edit Configuration [blue box] and then fill in the fields that I have indicated in this screenshot as being important. point it to the virtual environment you setup above.

1. Make sure to point the interpreter at what was set in the previous sections
2. Select the main.py that is in the wall_e repo
3. Set the working directory to the wall_e folder in the wall_e repo
4. If you have gone through ./run_walle.sh script, then you need to provide the absolute path to the wall_e.env file it created in the CI/validate_and_deploy/2_deploy/user_scripts/ folder