Skip to content

Commit

Permalink
Merge pull request #538 from ARISE-Initiative/mac-users-docs
Browse files Browse the repository at this point in the history
add instructions for mac users in docs
  • Loading branch information
kevin-thankyou-lin authored Nov 4, 2024
2 parents 3ef14bb + fb2c799 commit 1a2e275
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/basicusage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
## Running Standardized Environments
**robosuite** offers a set of standardized manipulation tasks for benchmarking purposes. These pre-defined environments can be easily instantiated with the `make` function. The APIs we provide to interact with our environments are simple and similar to the ones used by [OpenAI Gym](https://github.com/openai/gym/). Below is a minimalistic example of how to interact with an environment.

<div class="admonition warning">
<p class="admonition-title">Attention Mac users!</p>

Mac users who wish to use the default mjviewer renderer need to prepend the "python" command with "mj": `mjpython ...`
</div>

```python
import numpy as np
import robosuite as suite
Expand Down
6 changes: 6 additions & 0 deletions docs/demos.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

We provide a collection of [demo scripts](https://github.com/ARISE-Initiative/robosuite/tree/master/robosuite/demos) to showcase the functionalities in **robosuite**.

<div class="admonition warning">
<p class="admonition-title">Attention Mac users!</p>

For these scripts, Mac users who wish to use the default mjviewer renderer need to prepend the "python" command with "mj": `mjpython ...`
</div>

### Environment Configuration
The `demo_random_action.py` script is the starter demo script that you should try first. It highlights the modular design of our simulated environments. It enables users to create new simulation instances by choosing one [environment](modules/environments), one or more [robots](modules/robots), and their [controllers](modules/controllers) from the command line. The script creates an environment instance and controls the robots with uniform random actions drawn from the controller-specific action space. The list of all environments, robots, controllers, and gripper types supported in the current version of **robosuite** are defined by `suite.ALL_ENVIRONMENTS`, `suite.ALL_ROBOTS`, `suite. ALL_PART_CONTROLLERS`, and `suite.ALL_GRIPPERS` respectively.

Expand Down
12 changes: 12 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ The base installation requires the MuJoCo physics engine (with [mujoco](https://
$ python -m robosuite.demos.demo_random_action
```

<div class="admonition warning">
<p class="admonition-title">Attention Mac users!</p>

Mac users who wish to use the default mjviewer renderer need to prepend the "python" command with "mj": `mjpython ...`
</div>

### Install from source

1. Clone the robosuite repository
Expand All @@ -41,6 +47,12 @@ The base installation requires the MuJoCo physics engine (with [mujoco](https://
$ python robosuite/demos/demo_random_action.py
```

<div class="admonition warning">
<p class="admonition-title">Attention Mac users!</p>

Mac users who wish to use the default mjviewer renderer need to prepend the "python" command with "mj": `mjpython ...`
</div>

### Installing on Windows

It is common to run into issues when installing **robosuite** on a Windows machine. **robosuite** can be installed on Windows using the following steps.
Expand Down

0 comments on commit 1a2e275

Please sign in to comment.