diff --git a/docs/index.rst b/docs/index.rst index 17dae2c9..1f465b2d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,6 +31,7 @@ The best place to start is :ref:`about` :caption: Contents: :hidden: + source/getting_started source/about source/config source/primaite_session diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index a0adf751..3365732a 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -4,7 +4,7 @@ User Guide Getting Started **************** -# PrimAITE +**PrimAITE** ## About The Project 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. -## What's PrimAITE built with +**What's PrimAITE built with** - [OpenAI's Gym](https://gym.openai.com/) - [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) -## 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: @@ -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. -### Installation from source -#### 1. Navigate to the PrimAITE folder and create a new python virtual environment (venv) +Installation from source +1. Navigate to the PrimAITE folder and create a new python virtual environment (venv) -```unix -python3 -m venv -``` -#### 2. Activate the venv +`python3 -m venv ` -##### Unix -```bash -source /bin/activate -``` +2. Activate the venv -##### Windows -```powershell -.\\Scripts\activate -``` +`source /bin/activate` -#### 3. Install `PrimAITE` into the venv along with all of it's dependencies +Windows +`.\\Scripts\activate` -```bash -python3 -m pip install -e . -``` +3. Install `PrimAITE` into the venv along with all of it's dependencies + +`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 @@ -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`) -```bash -python3 -m pip install -e .[tensorflow] -``` -### Development Installation +`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: -```bash -python3 -m pip install -e .[dev] -``` +`python3 -m pip install -e .[dev]`