oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed the rst syntax

Browse Source
This commit is contained in:
Brian Kanyora
2023-07-07 16:25:55 +01:00
parent 4ef7831bfa
commit 752a611b89
2 changed files with 19 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/index.rst
View File

@@ -31,6 +31,7 @@ The best place to start is :ref:`about`
:caption: Contents: :caption: Contents:
:hidden: :hidden:
source/getting_started
source/about source/about
source/config source/config
source/primaite_session source/primaite_session

47
docs/source/getting_started.rst
View File

@@ -4,7 +4,7 @@ User Guide
Getting Started Getting Started
**************** ****************
# PrimAITE **PrimAITE**
## About The Project ## About The Project
PrimAITE (**PrimAITE**) simulation environment for training AI under the ARCD programme.It incorporates the functionality required PrimAITE (**PrimAITE**) simulation environment for training AI under the ARCD programme.It incorporates the functionality required
@@ -12,7 +12,7 @@ of a Primary-level environment, as specified in the Dstl ARCD Training Environme
**PrimAITE** is currently under a closed development stage. **PrimAITE** is currently under a closed development stage.
## What's PrimAITE built with **What's PrimAITE built with**
- [OpenAI's Gym](https://gym.openai.com/) - [OpenAI's Gym](https://gym.openai.com/)
- [Networkx](https://github.com/networkx/networkx) - [Networkx](https://github.com/networkx/networkx)
@@ -20,9 +20,9 @@ of a Primary-level environment, as specified in the Dstl ARCD Training Environme
- [Rllib (part of Ray)](https://github.com/ray-project/ray) - [Rllib (part of Ray)](https://github.com/ray-project/ray)
## Getting Started with PrimAITE **Getting Started with PrimAITE**
### Pre-Requisites Pre-Requisites
In order to get **PrimAITE** installed, you will need to have the following installed: In order to get **PrimAITE** installed, you will need to have the following installed:
@@ -32,30 +32,22 @@ In order to get **PrimAITE** installed, you will need to have the following inst
**PrimAITE** is designed to be OS-agnostic, and thus should work on most variations/distros of Linux, Windows, and MacOS. **PrimAITE** is designed to be OS-agnostic, and thus should work on most variations/distros of Linux, Windows, and MacOS.
### Installation from source Installation from source
#### 1. Navigate to the PrimAITE folder and create a new python virtual environment (venv) 1. Navigate to the PrimAITE folder and create a new python virtual environment (venv)
```unix
python3 -m venv <name_of_venv>
```
#### 2. Activate the venv `python3 -m venv <name_of_venv>`
##### Unix 2. Activate the venv
```bash
source <name_of_venv>/bin/activate
```
##### Windows `source <name_of_venv>/bin/activate`
```powershell
.\<name_of_venv>\Scripts\activate
```
#### 3. Install `PrimAITE` into the venv along with all of it's dependencies Windows
`.\<name_of_venv>\Scripts\activate`
```bash 3. Install `PrimAITE` into the venv along with all of it's dependencies
python3 -m pip install -e .
``` `python3 -m pip install -e .`
This will install all the dependencies including algorithm libraries. These libraries This will install all the dependencies including algorithm libraries. These libraries
all use `torch`. If you'd like to install `tensorflow` for use with Rllib, you can do this manually all use `torch`. If you'd like to install `tensorflow` for use with Rllib, you can do this manually
@@ -63,15 +55,12 @@ or install `tensorflow` as an optional dependency by postfixing the command in s
To see all PrimAITE dependencies have a look at the dependencies page (:ref:`Dependencies`) To see all PrimAITE dependencies have a look at the dependencies page (:ref:`Dependencies`)
```bash `python3 -m pip install -e .[tensorflow]`
python3 -m pip install -e .[tensorflow]
``` Development Installation
### Development Installation
To install the development dependencies, postfix the command in step 3 above with the `[dev]` extra. Example: To install the development dependencies, postfix the command in step 3 above with the `[dev]` extra. Example:
```bash `python3 -m pip install -e .[dev]`
python3 -m pip install -e .[dev]
```