From e3ad1470dfe22b3dd6dbe0ec7e734f74262fb468 Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Mon, 10 Jul 2023 10:01:25 +0100 Subject: [PATCH] feature/1597: Small syntax changes --- docs/source/getting_started.rst | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 3365732a..ece4c4b8 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -6,7 +6,7 @@ Getting Started **PrimAITE** -## About The Project +About The Project PrimAITE (**PrimAITE**) simulation environment for training AI under the ARCD programme.It incorporates the functionality required of a Primary-level environment, as specified in the Dstl ARCD Training Environment @@ -36,18 +36,21 @@ Installation from source 1. Navigate to the PrimAITE folder and create a new python virtual environment (venv) -`python3 -m venv ` +``python3 -m venv `` 2. Activate the venv -`source /bin/activate` +Unix + +``source /bin/activate`` Windows -`.\\Scripts\activate` -3. Install `PrimAITE` into the venv along with all of it's dependencies +``.\\Scripts\activate`` + +1. 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 all use `torch`. If you'd like to install `tensorflow` for use with Rllib, you can do this manually @@ -55,12 +58,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`) -`python3 -m pip install -e .[tensorflow]` +``python3 -m pip install -e .[tensorflow]`` Development Installation To install the development dependencies, postfix the command in step 3 above with the `[dev]` extra. Example: -`python3 -m pip install -e .[dev]` +``python3 -m pip install -e .[dev]``