Skip to content

Installing Moonshot for User Interface

Setting up Virtual Environment

It is recommended to create a new Python virtual environment in your working directory before proceeding with installation. To do so, enter working directory and proceed with following steps:

$ python -m venv venv
$ venv/Scripts/Activate.ps1

$ python -m venv venv
$ venv/Scripts/activate.bat

$ python -m venv venv
$ source venv/bin/activate

Dependencies needed for installation

This project strictly requires Python 3.11. Ensure that you have Python 3.11 installed on your system before proceeding with installation and usage.

Software Version Requirement
Python v3.11
NodeJs (for UI) v20.11.1 LTS or above
npm v10.8.0 or above
git

Install Moonshot

Run the following command in a virtual environment of your choice:

$ pip install "aiverify-moonshot[all]"

If you face issues installing NodeJS, install nodejs separately through

$ pip install nodejs

Once installed, Moonshot provides commands to download all the test assets and UI required to start testing your AI system:

$ python -m moonshot -i moonshot-data -i moonshot-ui

Run Moonshot UI with the following command:

$ python -m moonshot web

Lastly, access Moonshot UI using a browser (http://localhost:3000).

Warning

If you are operating on an x86 MacOS, you may encounter difficulties when attempting to install the dependency for moonshot-data. Please refer to this FAQ for a potential solution.

Info

Moonshot is optimised for Chrome browser. Users are recommended to use Chrome browser for best experience compared to other browsers.

Moonshot provides logging capabilities. Refer to this section for more information.