Skip to content

Latest commit

 

History

History
55 lines (46 loc) · 1.99 KB

README.md

File metadata and controls

55 lines (46 loc) · 1.99 KB
Raw

Animal-AI Configuration Assistant

This library allows users to debug and visualise Animal-AI configuration files.

Getting started

This section will guide you through installing and using Animal-AI Configuration Assistant locally.

Prerequisites

Installation

  1. Clone this repository to your local machine

    git clone [email protected]:mgm21/aai-config-assist.git
cd aai-config-assist

  2. Set up your virtual environment in the root of the cloned repository

    1. Linux/macOS 
      python -m venv venv
source venv/bin/activate
    2. Windows 
      python -m venv venv
venv\Scripts\activate

  3. Install the required packages in the development environment

    pip install -r requirements.txt

Using the library

  1. Open the running_app.py file in an editor of your choice (Vim, TextEdit, VS Code, Pycharm...)
  2. Replace the config_path variable with the path from the repository root to your .yaml configuration file. For example, if your configuration file is aai-config-assist/config.yaml then your path would be os.path.join("example_configs", "config.yaml")
  3. Open Terminal, and navigate to the root of this repository. You can run pwd in Terminal to ensure that your working directory is the aai-config-assistant repository on your local machine.
  4. In Terminal, enter the following command to execute the running_app.py 
    python -m scripts.checking_and_visualising

You should now see a visualisation of your configuration arena as well as a summary of the overlaps between items in your configuration (in the Terminal log output).

If you run into any issues, please get in touch (see Contact section below).

License

MIT License

Contact

Matteo G. Mecattaf - LinkedIn