From 4ef7831bfa6cf0f4d93d94cee2bde2211449d281 Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Fri, 7 Jul 2023 11:37:57 +0100 Subject: [PATCH 01/13] Added a getting started file --- docs/source/getting_started.rst | 109 ++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 docs/source/getting_started.rst diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst new file mode 100644 index 00000000..a0adf751 --- /dev/null +++ b/docs/source/getting_started.rst @@ -0,0 +1,109 @@ +User Guide +=========== + +Getting Started +**************** + +# PrimAITE + +## 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 + +**PrimAITE** is currently under a closed development stage. + +## What's PrimAITE built with + +- [OpenAI's Gym](https://gym.openai.com/) +- [Networkx](https://github.com/networkx/networkx) +- [Stable Baselines 3](https://github.com/DLR-RM/stable-baselines3) +- [Rllib (part of Ray)](https://github.com/ray-project/ray) + + +## 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 +#### 1. Navigate to the PrimAITE folder and create a new python virtual environment (venv) + +```unix +python3 -m venv +``` + +#### 2. Activate the venv + +##### Unix +```bash +source /bin/activate +``` + +##### Windows +```powershell +.\\Scripts\activate +``` + +#### 3. Install `PrimAITE` into the venv along with all of it's dependencies + +```bash +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 +or install `tensorflow` as an optional dependency by postfixing the command in step 3 above with the `[tensorflow]` extra. Example: + +To see all PrimAITE dependencies have a look at the dependencies page (:ref:`Dependencies`) + +```bash +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] +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 752a611b8940ec949f706c82149aec2287a6c44b Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Fri, 7 Jul 2023 16:25:55 +0100 Subject: [PATCH 02/13] Fixed the rst syntax --- docs/index.rst | 1 + docs/source/getting_started.rst | 47 +++++++++++++-------------------- 2 files changed, 19 insertions(+), 29 deletions(-) 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]` From 23adc740cdd1b337211b130891a3ff422c2df247 Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Fri, 7 Jul 2023 16:32:35 +0100 Subject: [PATCH 03/13] Resolved more syntax errors --- docs/source/primaite-dependencies.rst | 258 +++++++++++++------------- 1 file changed, 129 insertions(+), 129 deletions(-) diff --git a/docs/source/primaite-dependencies.rst b/docs/source/primaite-dependencies.rst index 48f835fe..52984d16 100644 --- a/docs/source/primaite-dependencies.rst +++ b/docs/source/primaite-dependencies.rst @@ -1,43 +1,43 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | Name | Version | License | URL | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| Babel | 2.12.1 | BSD License | https://babel.pocoo.org/ | +| Babel | 2.11.0 | BSD License | https://babel.pocoo.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| GPUtil | 1.4.0 | MIT | https://github.com/anderskm/gputil | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| Gymnasium | 0.26.3 | MIT | https://gymnasium.farama.org/ | +| DataProperty | 0.55.0 | MIT License | https://github.com/thombashi/DataProperty | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | Jinja2 | 3.1.2 | BSD License | https://palletsprojects.com/p/jinja/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| Markdown | 3.4.3 | BSD License | https://Python-Markdown.github.io/ | +| Mako | 1.2.4 | MIT License | https://www.makotemplates.org/ | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| Markdown | 3.4.1 | BSD License | https://Python-Markdown.github.io/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | MarkupSafe | 2.1.2 | BSD License | https://palletsprojects.com/p/markupsafe/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| Pillow | 9.5.0 | Historical Permission Notice and Disclaimer (HPND) | https://python-pillow.org | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| PyWavelets | 1.4.1 | MIT License | https://github.com/PyWavelets/pywt | +| Pillow | 9.4.0 | Historical Permission Notice and Disclaimer (HPND) | https://python-pillow.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | PyYAML | 6.0 | MIT License | https://pyyaml.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| Pygments | 2.15.1 | BSD License | https://pygments.org | +| Pygments | 2.14.0 | BSD License | https://pygments.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| Send2Trash | 1.8.2 | BSD License | https://github.com/arsenetar/send2trash | +| SQLAlchemy | 2.0.1 | MIT License | https://www.sqlalchemy.org | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| Send2Trash | 1.8.0 | BSD License | https://github.com/arsenetar/send2trash | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | Sphinx | 6.1.3 | BSD License | https://www.sphinx-doc.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| Werkzeug | 2.3.4 | BSD License | UNKNOWN | +| Werkzeug | 2.2.3 | BSD License | https://palletsprojects.com/p/werkzeug/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | absl-py | 1.4.0 | Apache Software License | https://github.com/abseil/abseil-py | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | aiofiles | 22.1.0 | Apache Software License | https://github.com/Tinche/aiofiles | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| aiosignal | 1.3.1 | Apache Software License | https://github.com/aio-libs/aiosignal | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| aiosqlite | 0.19.0 | MIT License | UNKNOWN | +| aiosqlite | 0.18.0 | MIT License | https://aiosqlite.omnilib.dev | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | alabaster | 0.7.13 | BSD License | https://alabaster.readthedocs.io | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| anyio | 3.7.0 | MIT License | https://anyio.readthedocs.io/en/stable/versionhistory.html | +| alembic | 1.9.2 | MIT License | https://alembic.sqlalchemy.org | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| anyio | 3.6.2 | MIT License | UNKNOWN | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | argon2-cffi | 21.3.0 | MIT License | https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -45,15 +45,17 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | arrow | 1.2.3 | Apache Software License | https://arrow.readthedocs.io | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| astroid | 2.15.5 | GNU Lesser General Public License v2 (LGPLv2) | UNKNOWN | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | asttokens | 2.2.1 | Apache 2.0 | https://github.com/gristlabs/asttokens | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | astunparse | 1.6.3 | BSD License | https://github.com/simonpercivall/astunparse | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| attrs | 23.1.0 | MIT License | https://www.attrs.org/en/stable/changelog.html | +| attrs | 22.2.0 | MIT License | https://www.attrs.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | backcall | 0.2.0 | BSD License | https://github.com/takluyver/backcall | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| beautifulsoup4 | 4.12.2 | MIT License | https://www.crummy.com/software/BeautifulSoup/bs4/ | +| beautifulsoup4 | 4.11.2 | MIT License | https://www.crummy.com/software/BeautifulSoup/bs4/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | bleach | 6.0.0 | Apache Software License | https://github.com/mozilla/bleach | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -61,21 +63,25 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | cachetools | 5.3.0 | MIT License | https://github.com/tkem/cachetools/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| certifi | 2023.5.7 | Mozilla Public License 2.0 (MPL 2.0) | https://github.com/certifi/python-certifi | +| certifi | 2022.12.7 | Mozilla Public License 2.0 (MPL 2.0) | https://github.com/certifi/python-certifi | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | cffi | 1.15.1 | MIT License | http://cffi.readthedocs.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | cfgv | 3.3.1 | MIT License | https://github.com/asottile/cfgv | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| charset-normalizer | 3.1.0 | MIT License | https://github.com/Ousret/charset_normalizer | +| chardet | 5.1.0 | GNU Lesser General Public License v2 or later (LGPLv2+) | https://github.com/chardet/chardet | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| click | 8.1.3 | BSD License | https://palletsprojects.com/p/click/ | +| charset-normalizer | 3.0.1 | MIT License | https://github.com/Ousret/charset_normalizer | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | cloudpickle | 2.2.1 | BSD License | https://github.com/cloudpipe/cloudpickle | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| cmaes | 0.9.1 | MIT License | https://github.com/CyberAgentAILab/cmaes | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | colorama | 0.4.6 | BSD License | https://github.com/tartley/colorama | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| comm | 0.1.3 | BSD License | https://github.com/ipython/comm | +| colorlog | 6.7.0 | MIT License | https://github.com/borntyping/python-colorlog | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| comm | 0.1.2 | BSD License | https://github.com/ipython/comm | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | contourpy | 1.0.7 | BSD License | UNKNOWN | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -83,155 +89,153 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | cycler | 0.11.0 | BSD License | https://github.com/matplotlib/cycler | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| debugpy | 1.6.7 | Eclipse Public License 2.0 (EPL-2.0); MIT License | https://aka.ms/debugpy | +| debugpy | 1.6.6 | Eclipse Public License 2.0 (EPL-2.0); MIT License | https://aka.ms/debugpy | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | decorator | 5.1.1 | BSD License | https://github.com/micheles/decorator | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | defusedxml | 0.7.1 | Python Software Foundation License | https://github.com/tiran/defusedxml | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| distlib | 0.3.6 | Python Software Foundation License | https://github.com/pypa/distlib | +| dill | 0.3.6 | BSD License | https://github.com/uqfoundation/dill | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| dm-tree | 0.1.8 | Apache Software License | https://github.com/deepmind/tree | +| distlib | 0.3.6 | Python Software Foundation License | https://github.com/pypa/distlib | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | docutils | 0.19 | BSD License; GNU General Public License (GPL); Public Domain; Python Software Foundation License | https://docutils.sourceforge.io/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| exceptiongroup | 1.1.1 | MIT License | https://github.com/agronholm/exceptiongroup/blob/main/CHANGES.rst | +| exceptiongroup | 1.1.0 | MIT License | https://github.com/agronholm/exceptiongroup/blob/main/CHANGES.rst | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | executing | 1.2.0 | MIT License | https://github.com/alexmojaki/executing | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| fastjsonschema | 2.17.1 | BSD License | https://github.com/horejsek/python-fastjsonschema | +| fastjsonschema | 2.16.2 | BSD License | https://github.com/horejsek/python-fastjsonschema | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| filelock | 3.12.0 | The Unlicense (Unlicense) | https://github.com/tox-dev/py-filelock | +| filelock | 3.9.0 | The Unlicense (Unlicense) | https://github.com/tox-dev/py-filelock | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | flake8 | 6.0.0 | MIT License | https://github.com/pycqa/flake8 | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| flatbuffers | 23.5.26 | Apache Software License | https://google.github.io/flatbuffers/ | +| flatbuffers | 23.1.21 | Apache Software License | https://google.github.io/flatbuffers/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| fonttools | 4.39.4 | MIT License | http://github.com/fonttools/fonttools | +| fonttools | 4.38.0 | MIT License | http://github.com/fonttools/fonttools | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | fqdn | 1.5.1 | Mozilla Public License 2.0 (MPL 2.0) | https://github.com/ypcrts/fqdn | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| frozenlist | 1.3.3 | Apache Software License | https://github.com/aio-libs/frozenlist | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | furo | 2023.3.27 | MIT License | UNKNOWN | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | gast | 0.4.0 | BSD License | https://github.com/serge-sans-paille/gast/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| google-auth | 2.19.0 | Apache Software License | https://github.com/googleapis/google-auth-library-python | +| google-auth | 2.16.1 | Apache Software License | https://github.com/googleapis/google-auth-library-python | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | google-auth-oauthlib | 0.4.6 | Apache Software License | https://github.com/GoogleCloudPlatform/google-auth-library-python-oauthlib | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | google-pasta | 0.2.0 | Apache Software License | https://github.com/google/pasta | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| greenlet | 2.0.2 | MIT License | https://greenlet.readthedocs.io/ | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | grpcio | 1.51.3 | Apache Software License | https://grpc.io | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | gym | 0.21.0 | UNKNOWN | https://github.com/openai/gym | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| gymnasium-notices | 0.0.1 | MIT License | https://github.com/Farama-Foundation/gym-notices | +| gym-notices | 0.0.8 | MIT License | https://github.com/Farama-Foundation/gym-notices | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| h5py | 3.9.0 | BSD License | https://www.h5py.org/ | +| h5py | 3.8.0 | BSD License | https://www.h5py.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| identify | 2.5.24 | MIT License | https://github.com/pre-commit/identify | +| huggingface-hub | 0.12.0 | Apache Software License | https://github.com/huggingface/huggingface_hub | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| huggingface-sb3 | 2.2.4 | Apache | https://github.com/huggingface/huggingface_sb3 | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| identify | 2.5.22 | MIT License | https://github.com/pre-commit/identify | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | idna | 3.4 | BSD License | https://github.com/kjd/idna | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| imageio | 2.29.0 | BSD License | https://github.com/imageio/imageio | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | imagesize | 1.4.1 | MIT License | https://github.com/shibukawa/imagesize_py | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| importlib | 1.0.4 | Python Software Foundation License | https://github.com/brettcannon/importlib | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | importlib-metadata | 4.13.0 | Apache Software License | https://github.com/python/importlib_metadata | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | iniconfig | 2.0.0 | MIT License | https://github.com/pytest-dev/iniconfig | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| ipykernel | 6.23.1 | BSD License | https://ipython.org | +| ipykernel | 6.21.1 | BSD License | https://ipython.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| ipython | 8.13.2 | BSD License | https://ipython.org | +| ipython | 8.9.0 | BSD License | https://ipython.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | ipython-genutils | 0.2.0 | BSD License | http://ipython.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | isoduration | 20.11.0 | ISC License (ISCL) | https://github.com/bolsote/isoduration | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| jax | 0.4.12 | Apache-2.0 | https://github.com/google/jax | +| isort | 5.12.0 | MIT License | https://pycqa.github.io/isort/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | jedi | 0.18.2 | MIT License | https://github.com/davidhalter/jedi | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| json5 | 0.9.14 | Apache Software License | https://github.com/dpranke/pyjson5 | +| json5 | 0.9.11 | Apache Software License | https://github.com/dpranke/pyjson5 | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | jsonpointer | 2.3 | BSD License | https://github.com/stefankoegl/python-json-pointer | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | jsonschema | 4.17.3 | MIT License | https://github.com/python-jsonschema/jsonschema | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| jupyter-events | 0.6.3 | BSD License | http://jupyter.org | +| jupyter-events | 0.5.0 | BSD License | http://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| jupyter-server | 1.24.0 | BSD License | https://jupyter-server.readthedocs.io | +| jupyter-ydoc | 0.2.2 | BSD 3-Clause License | https://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| jupyter-ydoc | 0.2.4 | BSD 3-Clause License | https://jupyter.org | +| jupyter_client | 8.0.2 | BSD License | https://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| jupyter_client | 8.2.0 | BSD License | https://jupyter.org | +| jupyter_core | 5.2.0 | BSD License | https://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| jupyter_core | 5.3.0 | BSD License | https://jupyter.org | +| jupyter_server | 2.2.1 | BSD License | https://jupyter-server.readthedocs.io | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| jupyter_server_fileid | 0.9.0 | BSD License | UNKNOWN | +| jupyter_server_fileid | 0.6.0 | BSD License | UNKNOWN | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | jupyter_server_terminals | 0.4.4 | BSD License | https://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | jupyter_server_ydoc | 0.6.1 | BSD License | https://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| jupyterlab | 3.6.1 | BSD License | https://jupyter.org | +| jupyterlab | 3.6.0 | BSD License | https://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | jupyterlab-pygments | 0.2.2 | BSD | https://github.com/jupyterlab/jupyterlab_pygments | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| jupyterlab_server | 2.22.1 | BSD License | https://jupyterlab-server.readthedocs.io | +| jupyterlab_server | 2.19.0 | BSD License | https://jupyterlab-server.readthedocs.io | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| keras | 2.12.0 | Apache Software License | https://keras.io/ | +| keras | 2.11.0 | Apache Software License | https://keras.io/ | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| keras-rl2 | 1.0.5 | MIT | https://github.com/wau/keras-rl2 | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | kiwisolver | 1.4.4 | BSD License | UNKNOWN | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| lazy_loader | 0.2 | BSD License | https://github.com/scientific-python/lazy_loader | +| lazy-object-proxy | 1.9.0 | BSD License | https://github.com/ionelmc/python-lazy-object-proxy | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| libclang | 16.0.0 | Apache Software License | https://github.com/sighingnow/libclang | +| libclang | 15.0.6.1 | Apache Software License | https://github.com/sighingnow/libclang | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| lz4 | 4.3.2 | BSD License | https://github.com/python-lz4/python-lz4 | +| lxml | 4.9.2 | BSD License | https://lxml.de/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| markdown-it-py | 2.2.0 | MIT License | https://github.com/executablebooks/markdown-it-py | +| markdown-it-py | 2.1.0 | MIT License | https://github.com/executablebooks/markdown-it-py | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | matplotlib | 3.7.1 | Python Software Foundation License | https://matplotlib.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | matplotlib-inline | 0.1.6 | BSD 3-Clause | https://github.com/ipython/matplotlib-inline | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| mavizstyle | 1.0.0 | UNKNOWN | UNKNOWN | +| mbstrdecoder | 1.1.1 | MIT License | https://github.com/thombashi/mbstrdecoder | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | mccabe | 0.7.0 | MIT License | https://github.com/pycqa/mccabe | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | mdurl | 0.1.2 | MIT License | https://github.com/executablebooks/mdurl | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| mistune | 2.0.5 | BSD License | https://github.com/lepture/mistune | +| mistune | 2.0.4 | BSD License | https://github.com/lepture/mistune | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| ml-dtypes | 0.2.0 | Apache Software License | UNKNOWN | +| nbclassic | 0.5.1 | BSD License | https://github.com/jupyter/nbclassic | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| mock | 5.0.2 | BSD License | http://mock.readthedocs.org/en/latest/ | +| nbclient | 0.7.2 | BSD License | https://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| mpmath | 1.3.0 | BSD License | http://mpmath.org/ | +| nbconvert | 7.2.9 | BSD License | https://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| msgpack | 1.0.5 | Apache Software License | https://msgpack.org/ | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| nbclassic | 0.5.6 | BSD License | https://github.com/jupyter/nbclassic | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| nbclient | 0.8.0 | BSD License | https://jupyter.org | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| nbconvert | 7.4.0 | BSD License | https://jupyter.org | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| nbformat | 5.9.0 | BSD License | https://jupyter.org | +| nbformat | 5.7.3 | BSD License | https://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | nest-asyncio | 1.5.6 | BSD License | https://github.com/erdewit/nest_asyncio | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | networkx | 3.1 | BSD License | https://networkx.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| nodeenv | 1.8.0 | BSD License | https://github.com/ekalinin/nodeenv | +| nodeenv | 1.7.0 | BSD License | https://github.com/ekalinin/nodeenv | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| notebook | 6.5.4 | BSD License | http://jupyter.org | +| notebook | 6.5.2 | BSD License | http://jupyter.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| notebook_shim | 0.2.3 | BSD License | UNKNOWN | +| notebook_shim | 0.2.2 | BSD License | UNKNOWN | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | numpy | 1.23.5 | BSD License | https://www.numpy.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -239,45 +243,43 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | opt-einsum | 3.3.0 | MIT | https://github.com/dgasmith/opt_einsum | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| overrides | 7.3.1 | Apache License, Version 2.0 | https://github.com/mkorpela/overrides | +| optuna | 3.1.0 | MIT License | https://optuna.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| packaging | 23.1 | Apache Software License; BSD License | https://github.com/pypa/packaging | +| packaging | 23.0 | Apache Software License; BSD License | https://github.com/pypa/packaging | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| pandas | 2.0.1 | BSD License | UNKNOWN | +| pandas | 1.5.3 | BSD License | https://pandas.pydata.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pandocfilters | 1.5.0 | BSD License | http://github.com/jgm/pandocfilters | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | parso | 0.8.3 | MIT License | https://github.com/davidhalter/parso | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| pathvalidate | 2.5.2 | MIT License | https://github.com/thombashi/pathvalidate | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pickleshare | 0.7.5 | MIT License | https://github.com/pickleshare/pickleshare | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| platformdirs | 3.5.1 | MIT License | https://github.com/platformdirs/platformdirs | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| plotly | 5.15.0 | MIT License | https://plotly.com/python/ | +| platformdirs | 2.6.2 | MIT License | https://github.com/platformdirs/platformdirs | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pluggy | 1.0.0 | MIT License | https://github.com/pytest-dev/pluggy | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| ppo | 0.1.1 | UNKNOWN | https://github.com/iffy/ppo | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pre-commit | 2.20.0 | MIT License | https://github.com/pre-commit/pre-commit | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| primaite | 2.0.0rc1 | GFX | UNKNOWN | +| primaite | 2.0.0.dev0 | GFX | UNKNOWN | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| primaite | 2.0.0rc1 | GFX | UNKNOWN | +| prometheus-client | 0.16.0 | Apache Software License | https://github.com/prometheus/client_python | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| primaite | 2.0.0rc1 | GFX | UNKNOWN | +| prompt-toolkit | 3.0.36 | BSD License | https://github.com/prompt-toolkit/python-prompt-toolkit | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| prometheus-client | 0.17.0 | Apache Software License | https://github.com/prometheus/client_python | +| protobuf | 3.19.6 | 3-Clause BSD License | https://developers.google.com/protocol-buffers/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| prompt-toolkit | 3.0.38 | BSD License | https://github.com/prompt-toolkit/python-prompt-toolkit | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| protobuf | 3.20.3 | BSD-3-Clause | https://developers.google.com/protocol-buffers/ | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| psutil | 5.9.5 | BSD License | https://github.com/giampaolo/psutil | +| psutil | 5.9.4 | BSD License | https://github.com/giampaolo/psutil | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pure-eval | 0.2.2 | MIT License | http://github.com/alexmojaki/pure_eval | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| pyasn1 | 0.5.0 | BSD License | https://github.com/pyasn1/pyasn1 | +| pyasn1 | 0.4.8 | BSD License | https://github.com/etingof/pyasn1 | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| pyasn1-modules | 0.3.0 | BSD License | https://github.com/pyasn1/pyasn1-modules | +| pyasn1-modules | 0.2.8 | BSD License | https://github.com/etingof/pyasn1-modules | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pycodestyle | 2.10.0 | MIT License | https://pycodestyle.pycqa.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -285,12 +287,16 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pyflakes | 3.0.1 | MIT License | https://github.com/PyCQA/pyflakes | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| pylint | 2.17.4 | GNU General Public License v2 (GPLv2) | https://github.com/PyCQA/pylint/issues | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pyparsing | 3.0.9 | MIT License | https://github.com/pyparsing/pyparsing/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pyproject_hooks | 1.0.0 | MIT License | https://github.com/pypa/pyproject-hooks | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pyrsistent | 0.19.3 | MIT License | https://github.com/tobgu/pyrsistent/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| pytablewriter | 0.64.2 | MIT License | https://github.com/thombashi/pytablewriter | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pytest | 7.2.0 | MIT License | https://docs.pytest.org/en/latest/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pytest-cov | 4.0.0 | MIT License | https://github.com/pytest-dev/pytest-cov | @@ -299,19 +305,17 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | python-dateutil | 2.8.2 | Apache Software License; BSD License | https://github.com/dateutil/dateutil | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| python-json-logger | 2.0.7 | BSD License | http://github.com/madzak/python-json-logger | +| python-json-logger | 2.0.4 | BSD License | http://github.com/madzak/python-json-logger | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| pytz | 2023.3 | MIT License | http://pythonhosted.org/pytz | +| pytz | 2022.7.1 | MIT License | http://pythonhosted.org/pytz | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| pywin32 | 306 | Python Software Foundation License | https://github.com/mhammond/pywin32 | +| pywin32 | 305 | Python Software Foundation License | https://github.com/mhammond/pywin32 | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | pywinpty | 2.0.10 | MIT | UNKNOWN | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| pyzmq | 25.1.0 | BSD License; GNU Library or Lesser General Public License (LGPL) | https://pyzmq.readthedocs.org | +| pyzmq | 25.0.0 | BSD License; GNU Library or Lesser General Public License (LGPL) | https://pyzmq.readthedocs.org | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| ray | 2.2.0 | Apache 2.0 | https://github.com/ray-project/ray | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| requests | 2.31.0 | Apache Software License | https://requests.readthedocs.io | +| requests | 2.28.2 | Apache Software License | https://requests.readthedocs.io | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | requests-oauthlib | 1.3.1 | BSD License | https://github.com/requests/requests-oauthlib | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -319,17 +323,13 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | rfc3986-validator | 0.1.1 | MIT License | https://github.com/naimetti/rfc3986-validator | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| rich | 13.3.5 | MIT License | https://github.com/Textualize/rich | +| rich | 13.3.1 | MIT License | https://github.com/Textualize/rich | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| rl-zoo3 | 1.7.0 | MIT | https://github.com/DLR-RM/rl-baselines3-zoo | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | rsa | 4.9 | Apache Software License | https://stuvel.eu/rsa | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| ruff | 0.0.272 | MIT License | https://github.com/charliermarsh/ruff | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| scikit-image | 0.20.0 | BSD License | https://scikit-image.org | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| scipy | 1.10.1 | BSD License | https://scipy.org/ | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| shellingham | 1.5.0.post1 | ISC License (ISCL) | https://github.com/sarugaku/shellingham | +| sb3-contrib | 1.7.0 | MIT | https://github.com/Stable-Baselines-Team/stable-baselines3-contrib | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | six | 1.16.0 | MIT License | https://github.com/benjaminp/six | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -337,7 +337,7 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | snowballstemmer | 2.2.0 | BSD License | https://github.com/snowballstem/snowball | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| soupsieve | 2.4.1 | MIT License | https://github.com/facelessuser/soupsieve | +| soupsieve | 2.3.2.post1 | MIT License | https://github.com/facelessuser/soupsieve | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | sphinx-basic-ng | 1.0.0b1 | MIT License | https://github.com/pradyunsg/sphinx-basic-ng | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -345,6 +345,8 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | sphinx-copybutton | 0.5.2 | MIT License | https://github.com/executablebooks/sphinx-copybutton | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| sphinx-rtd-theme | 1.1.1 | MIT License | https://github.com/readthedocs/sphinx_rtd_theme | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | sphinxcontrib-applehelp | 1.0.4 | BSD License | https://www.sphinx-doc.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | sphinxcontrib-devhelp | 1.0.2 | BSD License | http://sphinx-doc.org/ | @@ -361,11 +363,9 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | stack-data | 0.6.2 | MIT License | http://github.com/alexmojaki/stack_data | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| sympy | 1.12 | BSD License | https://sympy.org | +| tabledata | 1.3.0 | MIT License | https://github.com/thombashi/tabledata | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| tabulate | 0.9.0 | MIT License | https://github.com/astanin/python-tabulate | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| tenacity | 8.2.2 | Apache Software License | https://github.com/jd/tenacity | +| tcolorpy | 0.1.2 | MIT License | https://github.com/thombashi/tcolorpy | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | tensorboard | 2.11.2 | Apache Software License | https://github.com/tensorflow/tensorboard | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ @@ -373,57 +373,57 @@ +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | tensorboard-plugin-wit | 1.8.1 | Apache 2.0 | https://whatif-tool.dev | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| tensorboardX | 2.6 | MIT License | https://github.com/lanpa/tensorboardX | +| tensorflow | 2.11.0 | Apache Software License | https://www.tensorflow.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| tensorflow | 2.12.0 | Apache Software License | https://www.tensorflow.org/ | +| tensorflow-estimator | 2.11.0 | Apache Software License | https://www.tensorflow.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| tensorflow-estimator | 2.12.0 | Apache Software License | https://www.tensorflow.org/ | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| tensorflow-intel | 2.12.0 | Apache Software License | https://www.tensorflow.org/ | +| tensorflow-intel | 2.11.0 | Apache Software License | https://www.tensorflow.org/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | tensorflow-io-gcs-filesystem | 0.31.0 | Apache Software License | https://github.com/tensorflow/io | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| termcolor | 2.3.0 | MIT License | https://github.com/termcolor/termcolor | +| termcolor | 2.2.0 | MIT License | https://github.com/termcolor/termcolor | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | terminado | 0.17.1 | BSD License | https://github.com/jupyter/terminado | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| tifffile | 2023.4.12 | BSD License | https://www.cgohlke.com | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | tinycss2 | 1.2.1 | BSD License | https://www.courtbouillon.org/tinycss2 | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | toml | 0.10.2 | MIT License | https://github.com/uiri/toml | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | tomli | 2.0.1 | MIT License | https://github.com/hukkin/tomli | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| torch | 2.0.1 | BSD License | https://pytorch.org/ | +| tomlkit | 0.11.8 | MIT License | https://github.com/sdispater/tomlkit | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| tornado | 6.3.2 | Apache Software License | http://www.tornadoweb.org/ | +| torch | 1.13.1 | BSD License | https://pytorch.org/ | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| tornado | 6.2 | Apache Software License | http://www.tornadoweb.org/ | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| tqdm | 4.64.1 | MIT License; Mozilla Public License 2.0 (MPL 2.0) | https://tqdm.github.io | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | traitlets | 5.9.0 | BSD License | https://github.com/ipython/traitlets | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| typer | 0.9.0 | MIT License | https://github.com/tiangolo/typer | +| typepy | 1.3.0 | MIT License | https://github.com/thombashi/typepy | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| typing_extensions | 4.6.2 | Python Software Foundation License | https://github.com/python/typing_extensions/issues | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| tzdata | 2023.3 | Apache Software License | https://github.com/python/tzdata | +| typing_extensions | 4.4.0 | Python Software Foundation License | https://github.com/python/typing_extensions/issues | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | uri-template | 1.2.0 | MIT License | https://github.com/plinss/uri_template/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| urllib3 | 1.26.16 | MIT License | https://urllib3.readthedocs.io/ | +| urllib3 | 1.26.14 | MIT License | https://urllib3.readthedocs.io/ | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | virtualenv | 20.21.0 | MIT License | https://github.com/pypa/virtualenv | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| webcolors | 1.13 | BSD License | UNKNOWN | +| wasabi | 1.1.1 | MIT | https://github.com/explosion/wasabi | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| webcolors | 1.12 | BSD License | https://github.com/ubernostrum/webcolors | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | webencodings | 0.5.1 | BSD License | https://github.com/SimonSapin/python-webencodings | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| websocket-client | 1.5.2 | Apache Software License | https://github.com/websocket-client/websocket-client.git | +| websocket-client | 1.5.0 | Apache Software License | https://github.com/websocket-client/websocket-client.git | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| wrapt | 1.14.1 | BSD License | https://github.com/GrahamDumpleton/wrapt | +| wrapt | 1.15.0 | BSD License | https://github.com/GrahamDumpleton/wrapt | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| y-py | 0.5.9 | MIT License | https://github.com/y-crdt/ypy | +| y-py | 0.5.5 | UNKNOWN | UNKNOWN | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | ypy-websocket | 0.8.2 | UNKNOWN | https://github.com/y-crdt/ypy-websocket | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| zipp | 3.15.0 | MIT License | https://github.com/jaraco/zipp | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| zipp | 3.12.0 | MIT License | https://github.com/jaraco/zipp | ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ \ No newline at end of file From e3ad1470dfe22b3dd6dbe0ec7e734f74262fb468 Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Mon, 10 Jul 2023 10:01:25 +0100 Subject: [PATCH 04/13] 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]`` From 3c9b8a272a23b8ca0e8e8efdb3e0a4c71ecb0544 Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Mon, 10 Jul 2023 10:28:27 +0100 Subject: [PATCH 05/13] Additional syntax changes --- docs/source/getting_started.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index ece4c4b8..5a720019 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -14,10 +14,10 @@ of a Primary-level environment, as specified in the Dstl ARCD Training Environme **What's PrimAITE built with** -- [OpenAI's Gym](https://gym.openai.com/) -- [Networkx](https://github.com/networkx/networkx) -- [Stable Baselines 3](https://github.com/DLR-RM/stable-baselines3) -- [Rllib (part of Ray)](https://github.com/ray-project/ray) +- OpenAI's Gym (https://gym.openai.com/) +- Networkx (https://github.com/networkx/networkx) +- Stable Baselines 3 (https://github.com/DLR-RM/stable-baselines3) +- Rllib (part of Ray) (https://github.com/ray-project/ray) **Getting Started with PrimAITE** @@ -48,20 +48,20 @@ Windows ``.\\Scripts\activate`` -1. Install `PrimAITE` into the venv along with all of it's dependencies +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 -or install `tensorflow` as an optional dependency by postfixing the command in step 3 above with the `[tensorflow]` extra. Example: +all use ``torch``. If you'd like to install ``tensorflow`` for use with Rllib, you can do this manually +or install ``tensorflow`` as an optional dependency by postfixing the command in step 3 above with the ``[tensorflow]`` extra. Example: To see all PrimAITE dependencies have a look at the dependencies page (:ref:`Dependencies`) ``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: +To install the development dependencies, postfix the command in step 3 above with the ``[dev]`` extra. Example: ``python3 -m pip install -e .[dev]`` From ecc06a5db045b86ed6c1706b2bb5189aea1f2f0c Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Mon, 10 Jul 2023 15:41:50 +0100 Subject: [PATCH 06/13] feature/1597: pre commit fix --- docs/source/getting_started.rst | 41 ++------------------------- docs/source/primaite-dependencies.rst | 2 +- 2 files changed, 4 insertions(+), 39 deletions(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 5a720019..827ca0bf 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -8,9 +8,9 @@ Getting Started 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 +of a Primary-level environment, as specified in the Dstl ARCD Training Environment -**PrimAITE** is currently under a closed development stage. +**PrimAITE** is currently under a closed development stage. **What's PrimAITE built with** @@ -49,7 +49,7 @@ Windows ``.\\Scripts\activate`` 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 @@ -64,38 +64,3 @@ 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]`` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/source/primaite-dependencies.rst b/docs/source/primaite-dependencies.rst index 52984d16..9ca8a03b 100644 --- a/docs/source/primaite-dependencies.rst +++ b/docs/source/primaite-dependencies.rst @@ -426,4 +426,4 @@ | ypy-websocket | 0.8.2 | UNKNOWN | https://github.com/y-crdt/ypy-websocket | +-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | zipp | 3.12.0 | MIT License | https://github.com/jaraco/zipp | -+-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ \ No newline at end of file ++-------------------------------+-------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ From 30d8478a787f776998174743bda9af1cc6cc9601 Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Tue, 11 Jul 2023 13:49:01 +0100 Subject: [PATCH 07/13] Addressing Sunils comments from my --- 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 827ca0bf..9495dc97 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -7,7 +7,7 @@ Getting Started **PrimAITE** About The Project -PrimAITE (**PrimAITE**) simulation environment for training AI under the ARCD programme.It incorporates the functionality required +PrimAITE (**PrimAITE**) is a 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 **PrimAITE** is currently under a closed development stage. @@ -26,9 +26,9 @@ Pre-Requisites In order to get **PrimAITE** installed, you will need to have the following installed: -- `python3.8+` -- `python3-pip` -- `virtualenv` +- ``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. @@ -54,13 +54,16 @@ Windows 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 -or install ``tensorflow`` as an optional dependency by postfixing the command in step 3 above with the ``[tensorflow]`` extra. Example: - -To see all PrimAITE dependencies have a look at the dependencies page (:ref:`Dependencies`) +or install ``tensorflow`` as an optional dependency by postfixing the command in step 3 above with the ``[tensorflow]`` extra. +Example: ``python3 -m pip install -e .[tensorflow]`` +To see all PrimAITE dependencies have a look at the dependencies page (:ref:`Dependencies`) + 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: ``python3 -m pip install -e .[dev]`` From 79724d6884d9cc8639ebf03c23264732beced046 Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Tue, 11 Jul 2023 14:15:02 +0100 Subject: [PATCH 08/13] Added a space --- docs/source/getting_started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 9495dc97..bc53dc97 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -7,7 +7,7 @@ Getting Started **PrimAITE** About The Project -PrimAITE (**PrimAITE**) is a simulation environment for training AI under the ARCD programme.It incorporates the functionality required +PrimAITE (**PrimAITE**) is a 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 **PrimAITE** is currently under a closed development stage. From 5b3663c3cf84e10d6d4d6c2ea274cfa1736ea693 Mon Sep 17 00:00:00 2001 From: Chris McCarthy Date: Tue, 11 Jul 2023 15:47:13 +0100 Subject: [PATCH 09/13] #1597 - Added code tabs to getting started page --- docs/index.rst | 16 ++- docs/source/getting_started.rst | 166 +++++++++++++++++++++++-------- docs/source/primaite_session.rst | 3 +- 3 files changed, 137 insertions(+), 48 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index ca7aae51..2c4bff17 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,14 +17,17 @@ This is similar to the approach taken by FVEY international partners (e.g. AUS C What is PrimAITE built with -------------------------------------- +.. TODO:: Add the new dependencies that we've added since v1.1.0 + * `OpenAI's Gym `_ is used as the basis for AI blue agent interaction with the PrimAITE environment * `Networkx `_ is used as the underlying data structure used for the PrimAITE environment * `Stable Baselines 3 `_ is used as a default source of RL algorithms (although PrimAITE is not limited to SB3 agents) +* `Ray RLlib `_ is used as an additional source of RL algorithms Where next? ------------ -The best place to start is :ref:`about` +Head over to the :ref:`getting-started` page to install and setup PrimAITE! .. toctree:: :maxdepth: 8 @@ -40,12 +43,15 @@ The best place to start is :ref:`about` PrimAITE Tests source/dependencies + +.. TODO: Add project links once public repo has been created + .. toctree:: :caption: Project Links: :hidden: .. - #Code <> - #Issues <> - #Pull Requests <> - #Discussions <> + Code + Issues + Pull Requests + Discussions diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 9495dc97..a5643510 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -1,24 +1,7 @@ -User Guide -=========== +.. _getting-started: Getting Started -**************** - -**PrimAITE** - -About The Project -PrimAITE (**PrimAITE**) is a 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 - -**PrimAITE** is currently under a closed development stage. - -**What's PrimAITE built with** - -- OpenAI's Gym (https://gym.openai.com/) -- Networkx (https://github.com/networkx/networkx) -- Stable Baselines 3 (https://github.com/DLR-RM/stable-baselines3) -- Rllib (part of Ray) (https://github.com/ray-project/ray) - +=============== **Getting Started with PrimAITE** @@ -26,44 +9,143 @@ Pre-Requisites In order to get **PrimAITE** installed, you will need to have the following installed: -- ``python3.8+`` -- ``python3-pip`` -- ``virtualenv`` + +.. tabs:: lang + + .. code-tab:: bash + :caption: Unix + + sudo add-apt-repository ppa:deadsnakes/ppa + sudo apt install python3.10 + sudo apt-get install python3-pip + sudo apt-get install python3-venv + + .. code-tab:: text + :caption: Windows (Powershell) + + - Manual install from: https://www.python.org/downloads/release/python-31011/ **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) +Install PrimAITE +**************** + +1. Create a primaite directory in your home directory: + +.. tabs:: lang + + .. code-tab:: bash + :caption: Unix + + mkdir ~/primaite + + .. code-tab:: powershell + :caption: Windows (Powershell) + + mkdir ~\primaite + +2. Navigate to the primaite directory and create a new python virtual environment (venv) + +.. tabs:: lang + + .. code-tab:: bash + :caption: Unix + + cd ~/primaite + python3 -m venv .venv + + .. code-tab:: powershell + :caption: Windows (Powershell) + + cd ~\primaite + python3 -m venv .venv + attrib +h .venv /s /d # Hides the .venv directory + +3. Activate the venv + +.. tabs:: lang + + .. code-tab:: bash + :caption: Unix + + source .venv/bin/activate + + .. code-tab:: powershell + :caption: Windows (Powershell) + + .\.venv\Scripts\activate -``python3 -m venv `` +4. Install PrimAITE using pip from PyPi -2. Activate the venv +.. tabs:: lang -Unix + .. code-tab:: bash + :caption: Unix -``source /bin/activate`` + pip install primaite -Windows + .. code-tab:: powershell + :caption: Windows (Powershell) -``.\\Scripts\activate`` + pip install primaite -3. Install `PrimAITE` into the venv along with all of it's dependencies +5. Perform the PrimAITE setup -``python3 -m pip install -e .`` +.. tabs:: lang -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 -or install ``tensorflow`` as an optional dependency by postfixing the command in step 3 above with the ``[tensorflow]`` extra. -Example: + .. code-tab:: bash + :caption: Unix -``python3 -m pip install -e .[tensorflow]`` + primaite setup -To see all PrimAITE dependencies have a look at the dependencies page (:ref:`Dependencies`) + .. code-tab:: powershell + :caption: Windows (Powershell) -Development Installation + primaite setup -To install the development dependencies, postfix the command in step 3 above with the ``[dev]`` extra. -Example: +Clone & Install PrimAITE for Development +**************************************** -``python3 -m pip install -e .[dev]`` +To be able to extend PrimAITE further, or to build wheels manually before install, clone the repository to a location +of your choice: + +.. TODO:: Add repo path once we know what it is + +.. code-block:: bash + + git clone + cd primaite + +Create and activate your Python virtual environment (venv) + +.. tabs:: lang + + .. code-tab:: bash + :caption: Unix + + python3 -m venv venv + source venv/bin/activate + + .. code-tab:: powershell + :caption: Windows (Powershell) + + python3 -m venv venv + .\venv\Scripts\activate + +Install PrimAITE with the dev extra + +.. tabs:: lang + + .. code-tab:: bash + :caption: Unix + + pip install -e .[dev] + + .. code-tab:: powershell + :caption: Windows (Powershell) + + pip install -e .[dev] + + +To view the complete list of packages installed during PrimAITE installation, go to the dependencies page (:ref:`Dependencies`). diff --git a/docs/source/primaite_session.rst b/docs/source/primaite_session.rst index a59b2361..219980dd 100644 --- a/docs/source/primaite_session.rst +++ b/docs/source/primaite_session.rst @@ -8,6 +8,7 @@ A PrimAITE session can be ran either with the ``primaite session`` command from (See :func:`primaite.cli.session`), or by calling :func:`primaite.main.run` from a Python terminal or Jupyter Notebook. Both the ``primaite session`` and :func:`primaite.main.run` take a training config and a lay down config as parameters. + .. tabs:: .. code-tab:: bash @@ -17,7 +18,7 @@ Both the ``primaite session`` and :func:`primaite.main.run` take a training conf source ./.venv/bin/activate primaite session ./config/my_training_config.yaml ./config/my_lay_down_config.yaml - .. code-tab:: bash + .. code-tab:: powershell :caption: Powershell CLI cd ~\primaite From 3c2076409622f993d93973e6d9a61c1c0417afc2 Mon Sep 17 00:00:00 2001 From: Chris McCarthy Date: Tue, 11 Jul 2023 15:50:37 +0100 Subject: [PATCH 10/13] #1597 - Fixed Project Links side bar --- docs/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 2c4bff17..9f76511e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -50,7 +50,6 @@ Head over to the :ref:`getting-started` page to install and setup PrimAITE! :caption: Project Links: :hidden: -.. Code Issues Pull Requests From f5e1ef7491ba2aadaaae3edae4a83f1e3d21f3a8 Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Thu, 13 Jul 2023 09:35:42 +0100 Subject: [PATCH 11/13] feature/1597: Added dependencies to the index.rst since v1.1.0. --- docs/index.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 9f76511e..95b622ba 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,12 @@ What is PrimAITE built with * `Networkx `_ is used as the underlying data structure used for the PrimAITE environment * `Stable Baselines 3 `_ is used as a default source of RL algorithms (although PrimAITE is not limited to SB3 agents) * `Ray RLlib `_ is used as an additional source of RL algorithms +* `Typer `_ is used for building CLIs (Command Line Interface applications) +* `Tensorflow `_ is used for training and inference of neural networks in machine learning +* `Jupyterlab `_ is used an extensible environment for interactive and reproducible computing, based on the Jupyter Notebook and Architecture +* `Platformdirs `_ is used for finding the right location to store user data and configuration but varies per platform +* `Plotly `_ is used for building high level charts + Where next? ------------ From fd2ab39edf0516640b20eebb80c3f3c5ac3d2155 Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Thu, 13 Jul 2023 09:36:04 +0100 Subject: [PATCH 12/13] feature/1597: Added dependencies to the index.rst since v1.1.0. --- docs/index.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 95b622ba..599f50d6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,8 +17,6 @@ This is similar to the approach taken by FVEY international partners (e.g. AUS C What is PrimAITE built with -------------------------------------- -.. TODO:: Add the new dependencies that we've added since v1.1.0 - * `OpenAI's Gym `_ is used as the basis for AI blue agent interaction with the PrimAITE environment * `Networkx `_ is used as the underlying data structure used for the PrimAITE environment * `Stable Baselines 3 `_ is used as a default source of RL algorithms (although PrimAITE is not limited to SB3 agents) From 50697c6f752e469f5cc6fbd4db2d24735f745e0b Mon Sep 17 00:00:00 2001 From: Brian Kanyora Date: Mon, 17 Jul 2023 09:23:11 +0000 Subject: [PATCH 13/13] Apply suggestions from code review --- docs/index.rst | 3 +-- docs/source/getting_started.rst | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 599f50d6..b079f8b4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -22,8 +22,7 @@ What is PrimAITE built with * `Stable Baselines 3 `_ is used as a default source of RL algorithms (although PrimAITE is not limited to SB3 agents) * `Ray RLlib `_ is used as an additional source of RL algorithms * `Typer `_ is used for building CLIs (Command Line Interface applications) -* `Tensorflow `_ is used for training and inference of neural networks in machine learning -* `Jupyterlab `_ is used an extensible environment for interactive and reproducible computing, based on the Jupyter Notebook and Architecture +* `Jupyterlab `_ is used as an extensible environment for interactive and reproducible computing, based on the Jupyter Notebook Architecture * `Platformdirs `_ is used for finding the right location to store user data and configuration but varies per platform * `Plotly `_ is used for building high level charts diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index a5643510..e0254cdb 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -7,7 +7,7 @@ Getting Started 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 a python version between 3.8 and 3.10 installed. If you don't already have it, this is how to install it: .. tabs:: lang