From f4cca24bfce34c110b2dd3d1f31d01c4cdffc4fe Mon Sep 17 00:00:00 2001 From: thomasbazeille <bazeille.thomas@gmail.com> Date: Wed, 13 Nov 2024 16:00:27 +0100 Subject: [PATCH] modifying README --- README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 56 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1322378..f7e8735 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,61 @@ Projet de controle / commande de drone convertible (le mavion) par IA (Reinforcement learning) - Application de divers algo de RL et test de l'approche TD-MPC -ref : +ref : - https://www.tdmpc2.com/ + +## Prerequisites + +- Python > 3.9 +- Poetry +- Git + +## âš™ï¸ Setup + +1. **Clone the repository** + + Use the following command to clone the repository: + + ```bash + git clone git@gitlab.isae-supaero.fr:p.pastor/i-mav.git + ``` + +2. **Install poetry** + + Poetry is a tool for dependency management in Python. Install it with the following command: + + ```bash + cd presetai + curl -sSL https://install.python-poetry.org | python - + ``` + +3. **Install dependencies** + + Use Poetry to install the project dependencies: + + ```bash + poetry install + ``` + +4. **Activate the virtual environment** + + Poetry creates a virtual environment for the project. To activate it, run the following command: + + ```bash + poetry shell + ``` + +5. **Modify the dependencies** + + Inside this project, use poetry as a package / dependency manager. E.g if you need to add scikit-learn, run: + + ```bash + poetry add scikit-learn@^1.4.0 + ``` + + Or simply: + + ```bash + poetry add scikit-learn@^1.4.0 + ``` -- GitLab