oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
462 Commits 3 Branches 10 Tags
efbb6ef8df4f21afdc2e50d4d5b181ad9adf85c1
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Chris McCarthy efbb6ef8df Added a CONTRIBUTING.md and added a URL to the Yawning-Titan reference in index.rst
2023-07-26 20:17:29 +01:00
.github
Dropped the ADF build files and updated the package name install step in python-package.yml. Added bug_report.md and feature_request.md files for GitHub
2023-07-26 20:05:44 +01:00
benchmark
Ran final v2.0.0 benchmark and dropped the release candidate benchmarks
2023-07-26 18:19:11 +01:00
diagram
feature/1637:
2023-07-20 10:54:42 +01:00
docs
Added a CONTRIBUTING.md and added a URL to the Yawning-Titan reference in index.rst
2023-07-26 20:17:29 +01:00
src/primaite
Bumped version to 2.0.0
2023-07-26 14:38:57 +01:00
tests
#1650 - Removed the commented out pytest.mark.skip statement now that the test does work.
2023-07-24 09:20:36 +01:00
.flake8
#1355 - Carried out full renaming in node.py, active_node.py, passive_node.py, and service_node.py to make params and variable names explicit.
2023-05-25 21:03:11 +01:00
.gitignore
RE-ran the benchmarks for v2.0.0rc1 and v2.0.0rc2 using the same config file. As expected, the versions perform almost identically as there's no real logic changes that would affect the agent between the two release candidates
2023-07-24 22:43:22 +01:00
.pre-commit-config.yaml
#917 - Fixed the RLlib integration
2023-06-30 16:52:57 +01:00
CHANGELOG.md
Bumped version to 2.0.0
2023-07-26 14:38:57 +01:00
CONTRIBUTING.md
Added a CONTRIBUTING.md and added a URL to the Yawning-Titan reference in index.rst
2023-07-26 20:17:29 +01:00
LICENSE
Add license
2023-07-20 10:03:05 +01:00
MANIFEST.in
#915 - Synced with dev
2023-06-09 15:49:48 +01:00
pyproject.toml
#1650 - Turned on the test. Also updated some references to the old primaite paths. Finally, pushed the deployment status classifier to Development Status :: 5 - Production/Stable
2023-07-21 16:49:17 +01:00
pytest.ini
Add tests for observations
2023-06-02 12:59:01 +01:00
README.md
Dropped the ADF build files and updated the package name install step in python-package.yml. Added bug_report.md and feature_request.md files for GitHub
2023-07-26 20:05:44 +01:00
setup.py
#1648 - Updated file header from 'Crown Owned Copyright (C) Dstl 2023. DEFCON 703. Shared in confidence.' to '© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK'
2023-07-21 14:54:09 +01:00

README.md

PrimAITE

Getting Started with PrimAITE

Pre-Requisites

In order to get PrimAITE installed, you will need to have the following installed:

  • python3.8+
  • python3-pip
  • virtualenv

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
Description
ARCD Primary-Level AI Training Environment (PrimAITE)
Readme 21 MiB
Languages
Python 80.2%
Jupyter Notebook 19.8%