Merge pull request #10 from aikkala/fl0fischer-patch-1

Add setup.py, update README

README.md

@@ -115,11 +115,23 @@ simulator = gym.make("uitb:mobl_arms_index_pointing-v0")
 ```
 
 
-## Setup
+## Installation / Setup
 
 - The conda environment defined in `conda_env.yml` should contain all required packages. Create a new conda env with `conda env create -f conda_env.yml` and activate it with `conda activate uitb`.
 
-- Tested only with EGL for headless rendering: enable with `export MUJOCO_GL=egl`
+- Alternatively, you can install the `uitb` python package from the main directory via
+  ```bash
+  pip install -e .
+  ```
+
+- **IMPORTANT:** In case of headless rendering (e.g., in Jupyter Notebook/Google Colab files), EGL needs to be set as rendering backend (requires a GPU), either from commmand line: 
+  ```bash
+  export MUJOCO_GL=egl
+  ```
+  or, using ipython line magic in .ipynb files:
+  ```python
+  %env MUJOCO_GL=egl
+  ```
 
 
 ## Training

setup.py

@@ -0,0 +1,23 @@
+from setuptools import setup
+
+setup(
+   name='uitb',
+   version='0.2.0',
+   author='Aleksi Ikkala',
+   author_email='aleksi.ikkala@gmail.com',
+   packages=['uitb'],
+   url='https://github.com/aikkala/user-in-the-box',
+   license='LICENSE',
+   description='Modeling and simulating HCI interaction tasks in MuJoCo',
+   long_description=open('README.md').read(),
+   python_requires='>=3.8',
+   install_requires=[
+       "gym", #>=0.26.0",
+       "mujoco>=2.2.0",
+       "stable_baselines3>=1.4.0", "torch",
+       "wandb", "tensorboard",
+       "numpy", "matplotlib", "scipy",
+       "opencv-python",
+       "ruamel.yaml",
+   ],
+)