Metadata-Version: 2.1
Name: mujoco_robot_environments
Version: 0.0.2
Summary: Simulation environments for basic manipulation tasks.
License: Apache-2.0
Author: Peter David Fagan
Author-email: peterdavidfagan@gmail.com
Requires-Python: ==3.10.6
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Requires-Dist: brax (>=0.10.4,<0.11.0)
Requires-Dist: dm-control (==1.0.16)
Requires-Dist: dm-reverb (==0.13.0) ; sys_platform == "linux"
Requires-Dist: envlogger[tfds] (>=1.2,<2.0)
Requires-Dist: evojax (>=0.2.16,<0.3.0)
Requires-Dist: evosax (>=0.1.6,<0.2.0)
Requires-Dist: huggingface-hub (>=0.23.0,<0.24.0)
Requires-Dist: hydra-core (>=1.3.2,<2.0.0)
Requires-Dist: inflect (>=7.0.0,<8.0.0)
Requires-Dist: ipywidgets (>=8.1.1,<9.0.0)
Requires-Dist: jupyterlab (>=4.0.9,<5.0.0)
Requires-Dist: lark (>=1.1.7,<2.0.0)
Requires-Dist: matplotlib (>=3.7.2,<4.0.0)
Requires-Dist: mujoco (>=3.1.1,<4.0.0)
Requires-Dist: mujoco_controllers (>=0.0.2,<0.0.3)
Requires-Dist: notebook (>=7.0.6,<8.0.0)
Requires-Dist: numpy (>=1.16.0,<2.0.0)
Requires-Dist: pillow (==10.0.0)
Requires-Dist: pytest (>=7.0.0,<8.0.0)
Requires-Dist: rlds (>=0.1.7,<0.2.0) ; sys_platform == "linux"
Requires-Dist: tensorflow-cpu (>=2.14.0,<3.0.0) ; sys_platform == "linux"
Requires-Dist: wandb (>=0.16.1,<0.17.0)
Description-Content-Type: text/markdown

# MuJoCo Robotics Environments 🤖

A set of software for creating and prototyping robot workspaces in MuJoCo.

## Getting Started

### Local Development 

Ensure all submodule are cloned with the following commands:

```bash
git submodule sync
git submodule update --init --recursive
```

Ensure you have python version 3.10.6 using [pyenv](https://github.com/pyenv/pyenv). Following this install the python virtual environment for this project with [poetry](https://python-poetry.org/) through running:

```bash
poetry install 
```

Activate the virtual environment with the following command:

```bash
poetry shell
```

### Package Installation 

Install from PYPI via (Note: for now only Linux is supported): 
```bash
pip install mujoco_robot_environments
```

Example usage:

```python
from mujoco_robot_environments.tasks.rearrangement import RearrangementEnv

env = RearrangementEnv(viewer=True)
env.reset()
...
```

## Task Environments

### Colour Sorting Task Environment

An toy environment for reasoning about visual semantics. This environment is compatible with training transporter networks and intended to be used in research and for robot learning education.

#### Scripted Expert Demonstrations (Data Collection)
[Screencast from 05-10-2024 11:45:47 AM.webm](https://github.com/peterdavidfagan/mujoco_robot_environments/assets/42982057/7ac279da-0268-4ef2-8d4a-85eed6a7f364)


#### Interactive Environment Tuning
[Screencast from 05-10-2024 10:44:19 AM.webm](https://github.com/peterdavidfagan/mujoco_robot_environments/assets/42982057/b4428fff-f58f-4f96-b91f-6c171afb20a2)




