Added GFX license conditions. Included LICENSE file in build. Fixed a few character issues in README.md

This commit is contained in:
Chris McCarthy
2023-07-27 11:40:29 +01:00
parent b40fb09c1f
commit b15be9796d
3 changed files with 44 additions and 15 deletions

28
LICENSE Normal file
View File

@@ -0,0 +1,28 @@
GFX License
GFX Conditions
These GFX conditions confirm the provision of the following artefacts as GFX by Defence Science and Technology
Laboratory UK (DSTL) to QinetiQ Training and Simulation Ltd (QTSL) (and subcontractors engaged in activity on task by
request to the QQ mailbox):
- PrimAITE Overview
- Access to PrimAITE & user instructions
- Track 2 tech support
Suppliers will be required to sign up to the QTSL Collaborative Working Environment (CWE) SyOPs and fill out a User
Access Request Form. Provided they have a minimum of Cyber Essentials, and the user has the required clearance, they
will then be provided with credentials to access the site by QQ.
DSTL mandate that any changes made to the PrimAITE source code be passed back to QTSL (during or on termination of the
task) so that QQ can capture any potential enhancements to PrimAITE.
This contains OFFICIAL information to be used to inform work on ARCD tasks (under SERAPIS).
The material is supplied in confidence to QQ and their subcontractors under SERAPIS, and is issued to inform only those
that need to know its contents in the course of their official duties whilst engaged in activities under the contract.
The material consists of proprietary information which is the property of the Crown. The information contained within
the material may constitute valuable technical information and be commercially sensitive in relation to third parties;
therefore it may not be used or copied for any non-Governmental or commercial purpose without the prior written consent
of DSTL. The material must be stored and protected appropriately.All material must be destroyed at the end of the task.
Please note the contractual obligations relating to provision of these materials.

View File

@@ -1,6 +1,6 @@
# PrimAITE
The ARCD Primary-level AI Training Environment (PrimAITE) provides an effective simulation capability for the purposes of training and evaluating AI in a cyber-defensive role. It incorporates the functionality required of a primary-level ARCD environment, which includes:
The ARCD Primary-level AI Training Environment (**PrimAITE**) provides an effective simulation capability for the purposes of training and evaluating AI in a cyber-defensive role. It incorporates the functionality required of a primary-level ARCD environment, which includes:
- The ability to model a relevant platform / system context;
@@ -24,15 +24,15 @@ PrimAITE presents the following features:
- Presents an OpenAI gym or RLLib interface to the environment, allowing integration with any OpenAI gym compliant defensive agents;
- Full capture of discrete logs relating to agent training (full system state, agent actions taken, instantaneous and average reward for every step of every episode);
- Full capture of discrete logs relating to agent training (full system state, agent actions taken, instantaneous and average reward for every step of every episode);
- NetworkXprovides laydown visualisationcapability.
- NetworkX provides laydown visualisation capability.
## Getting Started with PrimAITE
### 💫 Install & Run
**PrimAITE** is designed to be OS-agnostic, and thus should work on most variations/distros of Linux, Windows, and MacOS.
Currently, the PRimAITE wheel can only be installed from GitHub. This may change in the future with release to PyPi.
Currently, the PrimAITE wheel can only be installed from GitHub. This may change in the future with release to PyPi.
#### Windows (PowerShell)

View File

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
name = "primaite"
description = "PrimAITE (Primary-level AI Training Environment) is a simulation environment for training AI under the ARCD programme."
authors = [{name="Defence Science and Technology Laboratory UK", email="oss@dstl.gov.uk"}]
license = {text = "GFX"}
license = {file = "LICENSE"}
requires-python = ">=3.8, <3.11"
dynamic = ["version", "readme"]
classifiers = [
@@ -47,6 +47,7 @@ readme = {file = ["README.md"]}
[tool.setuptools]
package-dir = {"" = "src"}
include-package-data = true
license-files = ["LICENSE"]
[project.optional-dependencies]