Installation¶

Prerequisites¶

Ensure you have the following installed: - Python 3.8 or higher - pip (Python package installer) - Conda (for environment management)

Installation Steps¶

1. Clone the Repository¶

First, clone the project repository from GitHub:

git clone https://github.com/your-github-username/your-repo-name.git
cd your-repo-name

2. Set Up Conda Environment¶

Create and activate a new conda environment:

conda create -n campus_gym
conda activate campus_gym

3. Install Dependencies¶

Install the required packages using pip:

pip install -r requirements.txt

4. Configure Weights & Biases (wandb)¶

If you haven't already, sign up for a wandb account at https://wandb.ai. Then, log in via the command line:

wandb login

5. Set Up Configuration Files¶

Ensure all configuration files are in place and update the wandb settings with your username and project name. The configuration files are located in the config directory and include the following:

config/config_shared.yaml: Shared configuration settings
config/config_{agent_type}.yaml: Agent-specific configurations
config/optuna_config.yaml: Optuna hyperparameter optimization settings (if using)

For detailed usage instructions, please refer to the Usage Guide.