Minimal install vs Full install

There are two ways of installing RCareWorld.

Minimal install: Download the built executable files. You will only have access to the ADL environments we provide. You can not add new objects to the scene.
(✨Highly recommended) Full install: Install Unity and import the RCareWorld project into your Unity environment. You will unlock the full functionality of RCareWorld with the Unity community.

<aside> 💡 This is the installation guide for the minimal install version, but we highly recommend you install the full version.

</aside>

Install Python module

Follow the following steps to install the python module. If you would like to perform reinforcement learning, you need to also install rl-baselines3-zoo in rcare_py folder.

We recommend using conda for environment management. Check this for installing conda.

# Create conda environment
conda create -n rcare python=3.8
conda activate rcare

# OPTION1: clone Python repo (with https)
git clone <https://github.com/empriselab/RCareWorld.git> rcare_py

# OPTION2: clone Python repo (with ssh)
git clone [email protected]:empriselab/RCareWorld.git rcare_py

cd rcare_py

cd pyrcareworld
pip install -e .
cd ..

(Optional) Install rl-baseline3-zoo-1.1.0

Download the source code for rl-baseline3-zoo-1.1.0 from GitHub.

wget <https://github.com/DLR-RM/rl-baselines3-zoo/archive/refs/tags/v1.1.0.zip>
unzip v1.1.0.zip
cd rl-baselines3-zoo/
pip install -e .

(Optional) Install blender

Blender is needed for generating URDFs which are needed for planning human motion.

Check Blender’s website for installation:

Download — blender.org

After installing, add blender into your environment variables:

For Windows:
1. Open the Start menu and search for "Environment Variables" and select "Edit the system environment variables."
2. In the System Properties window, click on the "Environment Variables" button.
3. In the Environment Variables window, under the "System variables" section, scroll down and locate the "Path" variable. Select it and click on the "Edit" button.
4. In the Edit Environment Variable window, click on the "New" button and enter the path to your Blender installation directory. For example, if Blender is installed in "C:\Program Files\Blender Foundation\Blender", you would add "C:\Program Files\Blender Foundation\Blender" to the list.
5. Click "OK" in all open windows to save the changes.