Installation

NOTE: Tested on Ubuntu and Windows 10. If you run into issues, we recommend using Docker.

with Pip

1. Install Anaconda or Miniconda

   Visit https://www.anaconda.com/products/individual for instructions

2. Install additional dependencies (Ubuntu only)

   • XVFB to render without display (No MS Windows Support)

   • ffmpeg for video processing

   sudo apt-get install -y xvfb ffmpeg
   

3. Create Conda Virtual Environment

   conda create -n pistarlab python=3.7
   conda activate pistarlab
   conda install pip
   

4. Option 1 (Package only)

   pip install https://github.com/pistarlab/pistarlab/archive/refs/heads/main.zip#egg=pistarlab[all]
   

5. Option 2 (Package + Source)

   git clone  --single-branch --depth=1 http://github.com/pistarlab/pistarlab/
   cd pistarlab
   pip install -e .[all]
   

with Docker

1. Install Docker:

   Visit: https://docs.docker.com/engine/install/

2. Clone Repo

   docker pull docker.pkg.github.com/pistarlab/pistarlab/image:latest