Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# Basic Usage

After installing A2Perf, you can easily instantiate environments from different domains. Here are some examples:

## Circuit Training

    import gymnasium as gym

    env = gym.make('CircuitTraining-Ariane-v0')
    # Other available environments:
    # env = gym.make('CircuitTraining-ToyMacro-v0')

## Web Navigation

    import gymnasium as gym

    env = gym.make('WebNavigation-Difficulty-01-v0', num_websites=1)

## Quadruped Locomotion

    import gymnasium as gym

    env = gym.make('QuadrupedLocomotion-DogPace-v0')
    # Other available environments:
    # env = gym.make('QuadrupedLocomotion-DogTrot-v0')
    # env = gym.make('QuadrupedLocomotion-DogSpin-v0')

# Installation

## Installing from source

Note: We highly recommend using Conda to manage your environment for installing A2Perf, as it simplifies dependency management and ensures compatibility across different systems.

To install A2Perf from source, follow these steps:

1. Install the package:

       cd code

       # Install all domains
       pip install -e .[all]
       # Or install specific domains
       pip install -e .[circuit-training]
       pip install -e .[web-navigation]
       pip install -e .[quadruped-locomotion]

   If you do not need an editable installation, you can omit the `-e` flag:

       pip install .[all]