2 Installation, lancement, désinstallation

2.1 Principes techniques

Installation mono-poste, sous PC, Mac et Linux

Interface accessible via un navigateur internet (adresse http://127.0.0.1:3333/ ou localhost:3333 )

Les données et le logiciel restent sur le PC (pas besoin de connexion Internet)

Extension possible avec des plug-ins développés par la communauté (pas tous compatibles avec la dernière version)

Pour les développeurs :

2.2 Installation

Télécharger la dernière version officielle

Allez sur le menu Download du site officiel (http://openrefine.org/download.html) ou bien directement sur la page de téléchargement du dépot Github (https://github.com/OpenRefine/OpenRefine/releases/)

OpenRefine est écrit en langage Java. Sous Windows, deux versions sont disponibles : avec ou sans Java intégré :

  • En cas de doute, choisissez la version incluant Java (64 bits).
  • Si Java est déjà installé (Java Runtime Environment version 8 ou supérieur), vous pouvez choisir la version sans Java. Dans ce cas la variable d’environnement Windows $JAVA_PATH doit contenir le chemin du JRE. Sur un PC 64 bits, utiliser de préférence Java 64 bits, qui permettra d’allouer plus de 4 Go de mémoire à OpenRefine.

Téléchargez la dernière version correspondant à son système d’exploitation.

OpenRefine peut s’exécuter depuis n’importe quel emplacement, y compris depuis une clé USB.

Installer le programme :

  • pour Windows : décompresser le fichier zip téléchargé, déplacer le dossier créé à l’emplacement souhaité (“Bureau”, “Program Files”, “C:/”, etc)
  • pour Linux : décompresser le fichier tar.gz téléchargé, déplacer le dossier créé à l’emplacement souhaité
  • pour Mac : ouvrir le fichier dmg téléchargé, puis dans la fenêtre qui s’ouvre faire glisser l’icône OpenRefine dans le dossier Applications

Sous Windows, si OpenRefine n’est pas installé sur le bureau il peut être utile de faire manuellement un raccourci pour le retrouver plus rapidement.

Après installation, les fichiers zip, tar.gz ou dmg peuvent être supprimés.

2.3 Mise à jour

Supprimez la version installée précédemment.

Faites une sauvegarde des données et des extensions.

Installez la nouvelle version.

2.4 Sauvegarder les données et les extensions

Le données et les extensions ajoutées à OpenRefine sont stockées dans un dossier spécifique, distinct du dossier où est installé le programme exécutable. Elles persistent même si le dossier du programme exécutable est supprimé. Il est conseillé de les sauvegarder avant d’installer une nouvelle version d’OpenRefine, dans le cas -très improbable - où la nouvelle version entraînerait une corruption des données. Il peut être utile de les sauvegarder pour d’autres raisons.

  • pour Windows : les données peuvent être dans différents dossiers, en fonction de la version de Windows :
    • C:\Documents and Settings\[nom_de_l_usager]\Local Settings\Application Data\OpenRefine
    • C:\Users\[nom_de_l_usager]\AppData\Roaming\OpenRefine
    • C:\Users\[nom_de_l_usager]\AppData\Local\OpenRefine
    • C:\Users\[nom_de_l_usager]\OpenRefine
  • pour Mac : dossier /Users/[nom_de_l_usager]/Library/Application Support/OpenRefine
  • pour Linux : dossier ~/.local/share/openrefine/

Un lien permet d’accéder à ce dossier depuis l’interface d’OpenRefine : cliquez sur « Ouvrir un projet » puis sur le lien « Parcourir le dossier de l’espace de travail » en bas de l’écran listant tous les projets.

Parcourir le dossier de l’espace de travail

L’explorateur de fichiers s’ouvre. Sélectionnez tous les dossiers et copier les dans un autre emplacement.

Dossier de données

2.5 Paramétrage facultatif : ajouter de la mémoire

Par défaut OpenRefine utilisera 1,4 Go de mémoire vive au maximum. Si la machine dispose d’assez de mémoire il est fortement conseillé d’augmenter ce seuil en modifiant un fichier de configuration.

Sous Windows : dans le fichier refine.ini, modifier la ligne REFINE_MEMORY

refine.ini sous Windows

Sous Mac : ouvrir le fichier ‘/Applications/OpenRefine.app/Contents/info.plist’ et modifier la valeur <string>-Xmx1400</string> (par ex: <string>-Xmx4000</string> pour doubler la mémoire maximale)

2.6 Lancement du programme

  • pour Windows : exécuter openrefine.exe ou openrefine.bat
    • openrefine.exe s’exécute avec les paramètres par défaut
    • openrefine.bat prend en compte les paramètres définis dans òpenrefine.ini. Si ce fichier a été modifié, toujours passer par openrefine.bat.
  • pour Linux : exécuter ./refine
  • pour Mac : lancer l’application OpenRefine (dans la liste des applications)

OpenRefine se lance normalement automatiquement dans le navigateur par défaut de la machine, dans un nouvel onglet avec l’URL localhost:3333 ou 127.0.0.1:3333.
Il ne fonctionne qu’avec Chrome ou Firefox : si votre navigateur par défaut est Safari, IE ou Edge, fermez-le, ouvrez Chrome ou Firefox et saisissez dans un nouvel onglet l’URL localhost:3333.

2.7 Sortie du programme

Puisque le logiciel tourne en tâche de fond, fermer le navigateur ne suffit pas fermer proprement OpenRefine. Pour cela il faut…

  • sous Windows : fermer la console

Logs sous Windows

  • sous Mac : utiliser le menu Quitter

Icone dans le Dock sous Mac

2.8 Désinstallation

  • pour Windows et Linux : supprimer simplement le dossier contenant l’exécutable
  • pour Mac : supprimer l’application OpenRefine.app dans la liste des applications

Par défaut les données resteront stockées sur la machine. Pour les effacer, supprimer le dossier où elles sont contenues (cf plus haut)

2.9 Création et installation d’extensions

Des extensions (plugins) réalisées par la communauté peuvent être installées pour ajouter de nouvelles commandes dans l’interface graphique ou de nouvelles fonctions du langage GREL. Certaines extensions ne fonctionnent pas, ou pas correctement, avec la version la plus récente d’OpenRefine, une vérification est donc nécessaire avant de les utiliser.

2.9.1 Fonctionnement et création des extensions

Voir O. Stephens, Writing an extension to add new GREL functions to OpenRefine, 08/05/2017 et Write an extension dans le wiki officiel.

2.9.2 Installation d’une extension

  • Télécharger une extension (au format zip)
  • Décompresser
  • Trouver et ouvrir le dossier contenant les données sur l’ordinateur (voir plus haut)
  • S’il n’existe pas, créer un dossier « extensions » dans ce dossier Dossier de données avec dossier extensions
  • Fermer OpenRefine
  • Déplacer l’extension téléchargée dans le dossier « extensions » créé
  • Relancer OpenRefine

Après installation, OpenRefine signale que l’extension est installé (en haut à droite de chaque page). De nouvelles commandes enrichissent les menus, et/ou de nouvelles fonctions GREL.

2.9.3 Extensions utiles

En priorité :

Mais aussi :

2.9.4 Activité

Télécharger l’extension permettant l’export en RDF et celle permettant de croiser des données et installez-les