diff --git a/CHANGELOG.md b/CHANGELOG.md index 81fe5621..ec5b999d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Upgraded pydantic to version 2.7.0 - Upgraded Ray to version >= 2.9 - Added ipywidgets to the dependencies +- added ability to set PrimAITE between development and production modes via PrimAITE CLI ``mode`` command ## [Unreleased] - Made requests fail to reach their target if the node is off diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index bb6e0019..d88be5c9 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -141,3 +141,29 @@ of your choice: pip install -e .[dev] To view the complete list of packages installed during PrimAITE installation, go to the dependencies page (:ref:`Dependencies`). + +4. Set PrimAITE to run on development mode + +Running step 3 should have installed PrimAITE, verify this by running + +.. code-block:: bash + :caption: Unix + + primaite setup + +.. code-block:: powershell + :caption: Windows (Powershell) + + primaite setup + +To set PrimAITE to run in development mode: + +.. code-block:: bash + :caption: Unix + + primaite mode --dev + +.. code-block:: powershell + :caption: Windows (Powershell) + + primaite mode --dev