Skip to content

Commit

Permalink
Added instructions for PyPI installation
Browse files Browse the repository at this point in the history
  • Loading branch information
uchendui committed Sep 6, 2024
1 parent b285b3f commit f33d4c0
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 9 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,16 @@ A2Perf provides benchmark environments in the following domains:

## Installation

A2Perf can be installed on your local machine:
A2Perf can be installed directly from PyPI:

```bash
git clone https://github.com/Farama-Foundation/A2Perf.git
cd A2Perf
git submodule sync --recursive
git submodule update --init --recursive
pip install a2perf[all]
```

A2Perf can also be installed from source for development purposes:

```bash
git clone https://github.com/Farama-Foundation/A2Perf.git --recursive
pip install -e .[all]
```

Expand All @@ -66,6 +69,12 @@ pip install -e .[all]
To install specific packages, you can use the following commands:

```bash
# From PyPI
pip install a2perf[web_navigation]
pip install a2perf[circuit_training]
pip install a2perf[quadruped_locomotion]

# From source
pip install -e .[web_navigation]
pip install -e .[quadruped_locomotion]
pip install -e .[circuit_training]
Expand All @@ -79,8 +88,7 @@ It can be used for development and testing but if you want to conduct serious (
time and resource-extensive) experiments on Windows,
please consider
using [Docker](https://docs.docker.com/docker-for-windows/install/)
or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10) with Linux
version.
or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).

## API

Expand Down
17 changes: 15 additions & 2 deletions docs/content/basic_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,21 @@ env = gym.make('QuadrupedLocomotion-DogPace-v0')

# Installation

Note: The pip installation is not available yet. Users should install from
source for now.
## Installing from PyPI

To install A2Perf from PyPI, run the following command:

```bash
pip install a2perf
```

You can also install specific domains by specifying the package name:

```bash
pip install a2perf[web-navigation]
pip install a2perf[circuit-training]
pip install a2perf[quadruped-locomotion]
```

## Installing from source

Expand Down

0 comments on commit f33d4c0

Please sign in to comment.