From 3b809b38818cd642b6d18a7cbe2288809dca9f40 Mon Sep 17 00:00:00 2001 From: Djalim Simaila <DjalimS.pro@outlook.fr> Date: Mon, 22 May 2023 15:25:07 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(README.md):=20add=20install?= =?UTF-8?q?ation=20instructions=20for=20Windows,=20Linux,=20and=20Mac=20?= =?UTF-8?q?=E2=9C=A8=20feat(README.md):=20add=20automated=20installation?= =?UTF-8?q?=20scripts=20for=20Windows,=20Linux,=20and=20Mac=20The=20README?= =?UTF-8?q?=20file=20now=20includes=20instructions=20for=20both=20manual?= =?UTF-8?q?=20and=20automated=20installation=20of=20the=20program.=20Autom?= =?UTF-8?q?ated=20installation=20scripts=20have=20been=20added=20for=20Win?= =?UTF-8?q?dows,=20Linux,=20and=20Mac=20to=20simplify=20the=20installation?= =?UTF-8?q?=20process.=20The=20scripts=20install=20the=20required=20depend?= =?UTF-8?q?encies=20using=20pip.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 12 ++++++++++++ install_deps.bat | 1 + install_deps.command | 2 ++ install_deps.sh | 2 ++ launch.bat | 1 + launch.command | 2 ++ launch.sh | 2 ++ main.py | 1 + requirement.txt => requirements.txt | 3 ++- 9 files changed, 25 insertions(+), 1 deletion(-) create mode 100755 install_deps.bat create mode 100755 install_deps.command create mode 100755 install_deps.sh create mode 100755 launch.bat create mode 100755 launch.command create mode 100755 launch.sh rename requirement.txt => requirements.txt (59%) diff --git a/README.md b/README.md index f53a4cb..9768f9c 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,18 @@ L'outil permet également l'affichage de plusieurs graphiques, tels que : Veuillez noter que ce programme nécessite une version de Python 3.10 ou supérieure. +### Installation automatisée + +Le dépôt contient des scripts qui facilitent l'utilisation du programme. Cependant, ces scripts supposent que Python 3 est installé et accessible dans le PATH. + +Utilisateurs Windows : Exécutez `install_deps.bat` pour installer les dépendances. Cette étape n'est nécessaire qu'une seule fois. Ensuite, exécutez `launch.bat` pour lancer le programme. + +Utilisateurs Linux/Mac : Exécutez `install_deps.sh` pour installer les dépendances. Cette étape n'est nécessaire qu'une seule fois. Ensuite, exécutez `launch.sh` pour lancer le programme. + +Utilisateurs Mac : Exécutez `install_deps.command` pour installer les dépendances. Cette étape n'est nécessaire qu'une seule fois. Ensuite, exécutez `launch.command` pour lancer le programme. + +### Installation manuelle + Pour utiliser le programme, vous pouvez le cloner à partir du dépôt Git ou télécharger l'une des [versions disponibles](https://forgemia.inra.fr/scanner3d/analysemorphologique/-/releases) et installer les dépendances à l'aide de pip. ```bash diff --git a/install_deps.bat b/install_deps.bat new file mode 100755 index 0000000..39a9971 --- /dev/null +++ b/install_deps.bat @@ -0,0 +1 @@ +pip install -r requirements.txt \ No newline at end of file diff --git a/install_deps.command b/install_deps.command new file mode 100755 index 0000000..b03a638 --- /dev/null +++ b/install_deps.command @@ -0,0 +1,2 @@ +#!/bin/bash +python3 -m pip install -r requirements.txt \ No newline at end of file diff --git a/install_deps.sh b/install_deps.sh new file mode 100755 index 0000000..b03a638 --- /dev/null +++ b/install_deps.sh @@ -0,0 +1,2 @@ +#!/bin/bash +python3 -m pip install -r requirements.txt \ No newline at end of file diff --git a/launch.bat b/launch.bat new file mode 100755 index 0000000..11a5d8e --- /dev/null +++ b/launch.bat @@ -0,0 +1 @@ +main.py \ No newline at end of file diff --git a/launch.command b/launch.command new file mode 100755 index 0000000..bdd9a94 --- /dev/null +++ b/launch.command @@ -0,0 +1,2 @@ +#/bin/bash +python3 main.py \ No newline at end of file diff --git a/launch.sh b/launch.sh new file mode 100755 index 0000000..bdd9a94 --- /dev/null +++ b/launch.sh @@ -0,0 +1,2 @@ +#/bin/bash +python3 main.py \ No newline at end of file diff --git a/main.py b/main.py index e6de4ac..f3b59d4 100644 --- a/main.py +++ b/main.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Created on Fri Apr 21 2023 @name: app.py diff --git a/requirement.txt b/requirements.txt similarity index 59% rename from requirement.txt rename to requirements.txt index ce6e2a3..1a99dcc 100644 --- a/requirement.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ vispy==0.12.2 PyQt5==5.15.9 numpy==1.24.2 -PyYAML==6.0 \ No newline at end of file +PyYAML==6.0 +matplotlib==3.7.1 \ No newline at end of file -- GitLab