To use all features and functions in this repository, make sure that you have installed Python and Blender on your system.

Blender. Download and install Blender. If script_evaluate_packing_plan.py does not find the location of Blender, add the Blender path to bed-bpp_env.conf.

Python. Depending on your system, we suggest to use different Python versions (Take a look for which platform and Python version the Visualization Toolkit wheels are available.). We suggest to use the environment with

Note, that we will use python3.9 in the following instructions.

1. Create and activate a virtual Python environment

   (a) Check your Python version with

   dev@nb:~$ compgen -c python

   This command should list all available Python versions.

   
   

   (b) Create a virtual environment with

   dev@nb:~$ python3.9 -m venv /path/to/venv/bed-bpp

   ⚠️
   Change /path/to/venv/bed-bpp according to your needs.
   Note that you can remove a virtual environment with sudo rm -rf /path/to/venv/bed-bpp.

   
   

   (c) Activate the virtual environment with

   dev@nb:~$ source /path/to/venv/bed-bpp/bin/activate

   Now your terminal should look similar to

   (bed-bpp) dev@nb:~$ 

   (d) Add the full path to code/ to your PYTHONPATH.

⚠️
We added the script activate_venv.sh which automatically activates the venv and updates the PYTHONPATH.
Just enter your location of the virtual environment in line 2 and run the script with

source activate_venv.sh

2. Install the required packages

   (a) Upgrade pip with

   (bed-bpp) dev@nb:~$ /full/path/to/venv/bed-bpp/bin/python3 -m pip install --upgrade pip

   
   

   (b) Install the requirements with

   (bed-bpp) dev@nb:~$ pip install -r requirements.txt

⚠️ Note for Debugging with VS Code.
If you can’t find the Python interpreter of the virtual environment, you might set a venv path in VS Code. To do this, open the settings with "Ctrl + ," and search for "venv". Then, add the folder where your venv is stored to the field "Python: Venv Path".

Change the current working directory to

(bed-bpp) dev@nb:~$ cd RepoDir/bed-bpp-env/code/

and check whether the setup was successful by running

(bed-bpp) dev@nb:~/RepoDir/bed-bpp-env/code$ python3 demo_gym_palenv-py -v

After a few seconds you should see an image that is similar to the following