1.0 KiB
1.0 KiB
PrimAITE
Getting Started with PrimAITE
Pre-Requisites
In order to get PrimAITE installed, you will need to have the following installed:
python3.8+python3-pipvirtualenv
PrimAITE is designed to be OS-agnostic, and thus should work on most variations/distros of Linux, Windows, and MacOS.
Installation from source (Developer Install)
1. Create a new python virtual environment (venv)
python3 -m venv venv
2. Activate the venv
Unix
source venv/bin/activate
Windows (Powershell)
.\venv\Scripts\activate
3. Install primaite with the dev extra into the venv along with all of it's dependencies
python3 -m pip install -e .[dev]
4. Perform the PrimAITE setup:
primaite setup
Building documentation
The PrimAITE documentation can be built with the following commands:
Unix
cd docs
make html
Windows (Powershell)
cd docs
.\make.bat html