Skip to content

Commit d2e0767

Browse files
Update README.md
1 parent d5eb02a commit d2e0767

File tree

1 file changed

+155
-1
lines changed

1 file changed

+155
-1
lines changed

README.md

Lines changed: 155 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,24 @@ Ces avancées positionnent Pandore comme un outil polyvalent et efficace pour le
4242
## Installation avec Docker (Linux / Mac / Windows)
4343
Si vous n'avez jamais installé Python ou d'autres logiciels, Docker simplifie totalement l'installation. Pandore fonctionne dans un conteneur préconfiguré avec tous les paquets nécessaires.
4444

45+
## Installation rapide
46+
47+
**1. Installer Docker**
48+
- Linux / Mac / Windows : téléchargez et installez Docker Desktop depuis https://www.docker.com/get-started
49+
- Lancez l'application.
50+
- Ouvrez le Terminal de l'application et lancer :
51+
- `docker pull ghcr.io/obtic-sorbonne/pandore-toolbox:latest`
52+
- `docker run --rm -p 5000:5000 ghcr.io/obtic-sorbonne/pandore-toolbox:latest`
53+
54+
## Installation longue
55+
4556
**1. Installer Docker**
4657
- Linux / Mac / Windows : téléchargez et installez Docker Desktop depuis https://www.docker.com/get-started
4758
- Lancez l'application.
4859

4960
**2. Récupérer le dépôt GitHub**
50-
- Après installation, ouvrez un terminal (ou PowerShell sous Windows).
61+
62+
- Ouvrez le Terminal de l'application et lancez :
5163

5264
```bash
5365
git clone https://github.com/obtic-scai/Toolbox-site.git
@@ -79,6 +91,76 @@ docker run --rm -p 5000:5000 pandore-toolbox
7991

8092
-----
8193

94+
## Installation locale (venv)
95+
### Récupérer le dépôt GitHub
96+
- Créer un dossier ObTIC-Toolbox et ouvrir un terminal dans celui-ci.
97+
98+
- Cloner le répertoire Toobox-site :
99+
```bash
100+
git clone https://github.com/obtic-scai/Toolbox-site.git
101+
```
102+
103+
- Créer et activer un environnement virtuel (Python 3.6 et au-dessus) :
104+
```bash
105+
python3 -m venv toolbox-env
106+
source toolbox-env/bin/activate
107+
```
108+
109+
- Se placer dans le répertoire Toolbox-site :
110+
```bash
111+
cd Toolbox-site
112+
```
113+
114+
### Installer les éléments nécessaires
115+
116+
- Il est nécessaire de [télécharger le paquet Swig](https://sourceforge.net/projects/swig/files/swig/swig-3.0.12/swig-3.0.12.tar.gz/download?use_mirror=netix). Pour l'installer, lancer :
117+
```bash
118+
./swig-3.0.12/configure && make && sudo make install
119+
```
120+
121+
- Installer les paquets nécessaires à l'exécution de l'application :
122+
```bash
123+
pip install -r requirements.txt
124+
```
125+
126+
- Finalement, il faut lancer :
127+
```bash
128+
chmod +x install.sh
129+
bash install.sh
130+
```
131+
132+
Il se peut qu'il faille lancer les commandes suivantes :
133+
134+
```bash
135+
pip install -U pip setuptools wheel
136+
pip install -U spacy
137+
python -m spacy download en_core_web_sm
138+
python -m spacy download fr_core_news_sm
139+
python -m spacy download fr_core_news_md
140+
python -m spacy download fr_core_news_lg
141+
python -m spacy download es_core_news_sm
142+
python -m spacy download de_core_news_sm
143+
python -m spacy download da_core_news_sm
144+
python -m spacy download nl_core_news_sm
145+
python -m spacy download fi_core_news_sm
146+
python -m spacy download it_core_news_sm
147+
python -m spacy download pt_core_news_sm
148+
python -m spacy download el_core_news_sm
149+
python -m spacy download ru_core_news_sm
150+
```
151+
152+
### Lancer l'application
153+
154+
Placé dans le dossier Toolbox-site, lancer la commande :
155+
156+
```bash
157+
python3 toolbox_app.py
158+
```
159+
160+
Ouvrir le lien http://127.0.0.1:5000 dans un navigateur pour accéder à l'interface de la Toolbox ObTIC.
161+
162+
-----
163+
82164
## Pandore en ligne
83165

84166
Une [version de démonstration](https://obtic-gpu1.mesu.sorbonne-universite.fr:8550/) est disponible en ligne.
@@ -188,6 +270,78 @@ docker run --rm -p 5000:5000 pandore-toolbox
188270

189271
💡 Tip for advanced users: you can change the local port (5000) if the port is already in use, for example -p 8000:5000 to access http://localhost:8000
190272

273+
274+
## Local installation (venv)
275+
276+
### Retrieve the GitHub repository
277+
- Create a folder ObTIC-Toolbox and open a terminal in it.
278+
279+
- Clone the Toolbox-site directory:
280+
```bash
281+
git clone https://github.com/obtic-scai/Toolbox-site.git
282+
```
283+
284+
- Create and activate a virtual environment (Python 3.6 and above):
285+
```bash
286+
python3 -m venv toolbox-env
287+
source toolbox-env/bin/activate
288+
```
289+
290+
- Place yourself in the directory Toolbox-site:
291+
```bash
292+
cd Toolbox-site
293+
```
294+
295+
### Install the necessary elements
296+
297+
- It is necessary to [download the Swig package](https://sourceforge.net/projects/swig/files/swig/swig-3.0.12/swig-3.0.12.tar.gz/download?use_mirror=netix). To install it, launch:
298+
```bash
299+
./swig-3.0.12/configure && make && sudo make install
300+
```
301+
302+
- Install the packages needed to run the application:
303+
```bash
304+
pip install -r requirements.txt
305+
```
306+
307+
- Finally, you have to launch:
308+
```bash
309+
chmod +x install.sh
310+
bash install.sh
311+
```
312+
313+
You may need to run the following commands:
314+
315+
```bash
316+
pip install -U pip setuptools wheel
317+
pip install -U spacy
318+
python -m spacy download en_core_web_sm
319+
python -m spacy download fr_core_news_sm
320+
python -m spacy download fr_core_news_md
321+
python -m spacy download fr_core_news_lg
322+
python -m spacy download es_core_news_sm
323+
python -m spacy download de_core_news_sm
324+
python -m spacy download da_core_news_sm
325+
python -m spacy download nl_core_news_sm
326+
python -m spacy download fi_core_news_sm
327+
python -m spacy download it_core_news_sm
328+
python -m spacy download pt_core_news_sm
329+
python -m spacy download el_core_news_sm
330+
python -m spacy download ru_core_news_sm
331+
```
332+
333+
### Launch the application
334+
335+
Placed in the Toolbox-site folder, run the command:
336+
337+
```bash
338+
python3 toolbox_app.py
339+
```
340+
341+
Open the link http://127.0.0.1:5000 in a browser to access the ObTIC Toolbox interface.
342+
343+
-----
344+
191345
---
192346

193347
## Pandore online

0 commit comments

Comments
 (0)