Installation de Python : installation Conda

L'API Earth Engine pour Python peut être installée sur une machine locale via conda, un gestionnaire de paquets et d'environnement Python. Conda est fourni avec les distributions Python Anaconda et Miniconda. Anaconda est une plate-forme de programmation de science des données qui comprend plus de 1 500 packages, tandis que Miniconda n'inclut que conda et ses dépendances. L'une de ces distributions Python convient pour installer et utiliser l'API Earth Engine. Si vous ne connaissez pas ces distributions, veuillez consulter les liens correspondants pour en savoir plus.

Ce guide vous explique comment:

• Vérifier l'existence d'une installation conda
• Installer conda sur une machine locale
• Installer l'API Earth Engine pour Python
• Configurer les identifiants d'authentification
• Tester l'API

Remarque :Les étapes suivantes seront effectuées dans une invite de commande Windows ou un terminal Unix (Linux/Mac). Utilisez les onglets en haut de chaque section de code pour passer aux commandes adaptées à votre système d'exploitation.

Vérifier l'installation de conda

Si conda est déjà installé sur votre système, passez à la section Installer l'API. Si vous ne savez pas si conda est installé, vérifiez en saisissant la commande suivante dans votre interface de ligne de commande.

conda --help

Si conda est installé et que son chemin d'accès système est enregistré dans la variable d'environnement PATH, le contenu de l'aide conda devrait s'afficher dans le terminal. Si le contenu de l'aide s'affiche, passez à la section Installer l'API. Si conda n'est pas reconnu, le résultat se présente comme suit : conda introuvable ou non reconnu comme commande. Il est possible que le programme existe sur votre système, mais qu'il ne soit pas enregistré dans la variable d'environnement PATH. Même si c'est le cas, pour des raisons de cohérence, veuillez poursuivre avec la section Installer conda, car il est difficile de prendre en compte toutes les configurations système possibles. Tant que le dossier "miniconda3" n'existe pas dans votre dossier "Home", les instructions d'installation de conda suivantes devraient réussir. Pour en savoir plus sur l'emplacement et l'enregistrement de l'installation de conda, consultez les pages Installation de Miniconda et Installation d'Anaconda.

Installer Conda

Remarque :Si conda est déjà installé sur votre système, passez à la section Installer l'API.

Dans cette section, vous allez télécharger et installer Miniconda, qui servira de plate-forme Python pour accéder à l'API Earth Engine. Comme décrit ci-dessus, vous pouvez utiliser Miniconda ou Anaconda. Toutefois, pour minimiser l'impact sur votre système, ce guide décrit une installation Miniconda sans modification des variables d'environnement de votre système. Si vous préférez Anaconda, veuillez consulter les instructions d'installation fournies ici, puis passez à la section Installer l'API.

Installer Miniconda

Le téléchargement et l'installation de Miniconda se font en trois étapes:

1. Télécharger le programme d'installation Miniconda Python 3 64 bits dans votre répertoire d'accueil
2. Exécuter le programme d'installation
3. Supprimer le programme d'installation

Pour effectuer ces étapes, copiez et collez les lignes suivantes dans l'interface de ligne de commande appropriée pour votre système. Un dossier nommé "miniconda3" est ajouté à votre répertoire d'accueil.

1. Téléchargez le programme d'installation de Miniconda dans votre répertoire d'accueil.

Linux

wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda.sh

Mac

curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh -o ~/miniconda.sh

Windows

powershell -command "Invoke-WebRequest -Uri https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -OutFile ~\miniconda.exe"

2. Installez Miniconda de manière silencieuse, en acceptant les valeurs par défaut, dans votre répertoire d'accueil.

Linux

bash ~/miniconda.sh -b

Mac

bash ~/miniconda.sh -b

Windows

start /B /WAIT %UserProfile%\miniconda.exe /InstallationType=JustMe /AddToPath=0 /RegisterPython=0 /S /D=%UserProfile%\miniconda3

3. Supprimez le programme d'installation Miniconda de votre répertoire d'accueil.

Linux

rm ~/miniconda.sh

Mac

rm ~/miniconda.sh

Windows

del %UserProfile%\miniconda.exe

Tester l'installation de Miniconda

Imprimez le menu d'aide de la commande conda pour tester l'installation de Miniconda. Étant donné que Miniconda n'a pas été ajouté à la variable d'environnement PATH de votre système, vous devez d'abord activer conda pour cette session en appelant la commande activate par son chemin d'accès système complet. Si le test réussit, le contenu d'aide conda s'affiche dans le terminal. Exécutez les lignes suivantes dans l'interface de ligne de commande de votre système.

Linux

source $HOME/miniconda3/bin/activate
conda --help

Mac

source $HOME/miniconda3/bin/activate
conda --help

Windows

%UserProfile%\miniconda3\condabin\activate
conda --help

Remarque:Un environnement conda activé peut être désactivé en exécutant : conda deactivate.

Remarque:Si le chemin d'accès à Miniconda n'est pas défini en tant que variable d'environnement, comme dans le cas de cette installation, vous devez activer Miniconda pour chaque nouvelle session de ligne de commande à l'avenir, y compris pour l'utilisation de l'API. Utilisez la première commande de l'extrait de code ci-dessus pour activer Miniconda si nécessaire.

Ajouter Miniconda à la variable PATH

Attention :La modification de la variable PATH de votre système peut avoir des conséquences inattendues.

Vous pouvez éventuellement ajouter le chemin d'installation de Miniconda à la variable PATH de votre système, ce qui vous permettra d'interagir avec conda par un simple appel à conda sans avoir à exécuter d'abord la commande activate par son chemin d'accès complet. Les instructions suivantes expliquent comment ajouter l'installation Miniconda à la variable PATH de votre système.

Linux

Ajoutez le chemin d 'accès suivant à votre variable d'environnement PATH en suivant les instructions de la GUI ou de la ligne de commande ci-dessous.

$HOME/miniconda3/bin

GUI

1. Ouvrez le fichier .bashrc dans le répertoire $HOME dans un éditeur de texte.

xdg-open ~/.bashrc

2. Copiez et collez les lignes suivantes en bas du fichier.

# add path to conda
export PATH="$HOME/miniconda3/bin:$PATH"

3. Enregistrez le fichier et fermez l'éditeur de texte.

Remarque :Vous pouvez supprimer le chemin d'accès conda ajouté en supprimant les lignes que vous venez d'ajouter.

Ligne de commande

Saisissez la commande suivante dans un terminal pour ajouter le chemin d'accès conda au fichier ~/.bashrc.

printf '\n# add path to conda\nexport PATH="$HOME/miniconda3/bin:$PATH"\n' >> ~/.bashrc

Mac

Ajoutez le chemin d 'accès suivant à votre variable d'environnement PATH en suivant les instructions de la GUI ou de la ligne de commande ci-dessous.

$HOME/miniconda3/bin

GUI

1. Ouvrez le fichier .bashrc dans le répertoire $HOME dans un éditeur de texte.

touch ~/.bashrc; open -t ~/.bashrc

2. Copiez et collez les lignes suivantes en bas du fichier.

# add path to conda
export PATH="$HOME/miniconda3/bin:$PATH"

3. Enregistrez le fichier et fermez l'éditeur de texte.

Remarque :Vous pouvez supprimer le chemin d'accès conda ajouté en supprimant les lignes que vous venez d'ajouter.

Ligne de commande

Saisissez la commande suivante dans un terminal pour ajouter le chemin d'accès conda au fichier ~/.bashrc.

printf '\n# add path to conda\nexport PATH="$HOME/miniconda3/bin:$PATH"\n' >> ~/.bashrc

Windows

Ajoutez le chemin d'accès suivant à votre variable d'environnement "Path" en suivant les instructions de la GUI ou de la ligne de commande ci-dessous.

%UserProfile%\miniconda3\condabin

GUI

1. Saisissez la ligne suivante dans une invite de commande pour ouvrir la boîte de dialogue "Variable d'environnement".

rundll32 sysdm.cpl,EditEnvironmentVariables

2. Double-cliquez sur la variable "Chemin" sous la section "Utilisateur" pour la sélectionner et la modifier.

3. Cliquez sur le bouton "Modifier le texte" dans la nouvelle boîte de dialogue "Modifier" pour ouvrir l'éditeur.

4. Ajoutez la chaîne suivante à la fin de la valeur de la variable "Chemin" existante. Assurez-vous que l'entrée est entourée de points-virgules (;) pour la distinguer des entrées voisines.

%UserProfile%\miniconda3\condabin;

5. Cliquez sur les boutons "OK" jusqu'à ce que toutes les boîtes de dialogue soient fermées.

Remarque :Le chemin d'accès conda ajouté peut être supprimé en suivant la même méthode d'édition.

Ligne de commande

Utilisez la commande setx pour ajouter le chemin d'accès. À l'invite de commande, saisissez:

setx Path "%Path%%UserProfile%\miniconda3\condabin;"

Remarque :Redémarrez les interfaces de ligne de commande ouvertes pour que les modifications apportées aux variables d'environnement prennent effet.

Initialiser conda

Initialisez conda pour l'interaction avec le shell. Exécutez la commande précédente pour obtenir des informations sur l'initialisation de différents shells. Suivez les instructions ultérieures affichées dans la console lorsque vous saisissez la commande.

conda init --help

Après avoir redémarré votre interface de ligne de commande, vous devriez pouvoir activer l'environnement conda de base avec la commande suivante.

conda activate

Installer l'API

L'API Python Earth Engine est distribuée en tant que package conda-forge sur la page https://anaconda.org/conda-forge/earthengine-api. Il est installé avec la commande conda install. Avant l'installation, créez toutefois un environnement Conda spécifiquement pour Earth Engine. En installant l'API Earth Engine dans son propre environnement, vous vous assurez qu'elle et ses packages dépendants ne causeront pas de problèmes de gestion des versions avec votre environnement de base ni avec tout autre environnement que vous avez précédemment configuré, et inversement. Pour en savoir plus sur la gestion des environnements conda, consultez ce site.

Remarque :La première étape suivante suppose que vous venez de terminer la section Installer conda sans modifier les variables d'environnement ni initialiser conda pour l'utilisation du shell. La commande est structurée en conséquence. Si vous avez déjà installé conda par un autre moyen ou si vous l'avez enregistré pour l'utiliser dans le shell, veuillez faire ce qui est nécessaire pour activer conda, puis commencer à suivre les instructions à l'étape 2.

1. Activez votre environnement conda de base, si ce n'est pas déjà fait.

Linux

source $HOME/miniconda3/bin/activate

Mac

source $HOME/miniconda3/bin/activate

Windows

%UserProfile%\miniconda3\condabin\activate

2. Créez un environnement virtuel Conda pour l'API Earth Engine.

conda create --name ee

Vous êtes invité à confirmer la création de l'environnement. Faites-le.

3. Activez l'environnement conda ee.

conda activate ee

4. Installez l'API dans l'environnement conda ee. Assurez-vous que (ee) apparaît au début de la ligne de commande, ce qui indique que vous travaillez à partir de l'environnement ee.

conda install -c conda-forge earthengine-api

Vous êtes invité à confirmer l'installation de l'API et de ses dépendances. Après confirmation, conda téléchargera et installera les dépendances. Si tout se passe bien, vous disposez désormais d'un environnement conda appelé "ee" avec toutes les exigences requises pour accéder à l'API, ainsi que de l'outil de ligne de commande earthengine.

Obtenir des identifiants

Avant d'utiliser l'API Earth Engine ou l'outil de ligne de commande earthengine, vous devez effectuer une authentification unique qui autorise l'accès à Earth Engine au nom de votre compte Google. Pour vous authentifier, utilisez la commande authenticate de l'outil de ligne de commande earthengine.

Dans votre environnement conda ee, exécutez la commande suivante et suivez les instructions imprimées qui s'affichent. Une URL vous sera fournie pour générer un code d'autorisation une fois le contrat signé. Copiez le code d'autorisation, puis saisissez-le en ligne de commande.

earthengine authenticate

Lorsque vous saisissez le code d'autorisation, un jeton d'autorisation est enregistré dans un fichier d'identifiants, que vous trouverez ci-dessous. L'utilisation ultérieure de la commande ee.Initialize() de l'API et de l'outil de ligne de commande earthengine s'appuiera sur ce fichier pour l'authentification. Si vous souhaitez révoquer l'autorisation, il vous suffit de supprimer le fichier d'identifiants.

Linux

ls $HOME/.config/earthengine/credentials

Mac

ls $HOME/.config/earthengine/credentials

Windows

dir %UserProfile%\.config\earthengine\credentials

Tester l'API

Exécutez un script Python simple qui imprime les métadonnées d'un ensemble de données DEM pour tester l'installation de l'API. Un objet JSON doit s'afficher dans la console.

1. Démarrez un interpréteur python à partir de votre environnement ee Conda.

python

2. Exécutez les lignes Python suivantes une par une pour imprimer les métadonnées d'un ensemble de données DEM.

import ee

# Initialize the Earth Engine module.
ee.Initialize()

# Print metadata for a DEM dataset.
print(ee.Image('USGS/SRTMGL1_003').getInfo())

Utilisation ultérieure de l'API

Chaque fois que vous souhaitez utiliser l'API Earth Engine, vous devez d'abord activer votre environnement ee conda. La procédure d'activation dépend de si conda est enregistré pour être utilisé dans le shell ou non. Suivez les instructions ci-dessous qui correspondent à votre installation conda.

Conda non enregistré

La commande d'activation de l'environnement conda ee suivante suppose que conda a été installé en suivant les instructions de la section Installer conda ci-dessus, c'est-à-dire que le chemin d'installation est supposé basé sur les étapes précédentes. Exécutez la commande suivante dans une interface de ligne de commande.

Linux

source $HOME/miniconda3/bin/activate ee

Mac

source $HOME/miniconda3/bin/activate ee

Windows

%UserProfile%\miniconda3\condabin\activate ee

Conda enregistré

La commande d'activation de l'environnement conda ee suivante suppose que conda a été enregistré pour être utilisé dans le shell ou l'invite de commande en suivant les instructions de ce guide ou par d'autres moyens. Exécutez la commande suivante dans une interface de ligne de commande.

conda activate ee

Une fois la commande exécutée, (ee) doit s'afficher au début de la ligne de commande, ce qui indique que vous travaillez à partir de l'environnement ee.

Vous êtes maintenant prêt à démarrer un interpréteur Python et à accéder à l'API Python Earth Engine. Veuillez consulter la page Installation de Python pour obtenir des conseils généraux sur l'utilisation de l'API Python.

Mettre à jour l'API

Utilisez la commande conda update pour mettre à jour votre environnement ee vers la dernière version de l'API. N'oubliez pas d'activer d'abord votre environnement ee conda, s'il n'est pas déjà actif.

conda update -c conda-forge earthengine-api

Obtenez le numéro de version actuellement installé dans Python en imprimant la propriété __version__ de la bibliothèque ee. Démarrez un interpréteur Python en saisissant python dans la ligne de commande de l'environnement conda ee, puis saisissez les commandes suivantes.

import ee
print(ee.__version__)

Partager votre environnement ee

Il peut être utile de partager votre environnement Python conda avec d'autres personnes pour obtenir des résultats reproductibles et réplicables, en particulier lorsque vous avez installé des packages Python supplémentaires. Conda permet aux autres de reproduire facilement votre environnement.

Dans votre environnement conda ee, exécutez la commande suivante pour enregistrer un fichier YAML appelé "ee-shared-env" dans votre répertoire d'accueil, qui liste les spécifications de votre environnement.

Linux

conda env export > $HOME/ee-shared-env.yml

Mac

conda env export > $HOME/ee-shared-env.yml

Windows

conda env export > %UserProfile%\ee-shared-env.yml

Partagez le fichier obtenu. Le destinataire peut répliquer l'environnement en exécutant la commande conda suivante.

conda env create -f path-to-ee-shared-env.yml

Remarque :La première ligne du fichier ee-shared-env.yml définit le nom de l'environnement à créer. Conda ne remplace pas un environnement existant. Il se peut donc que vous deviez modifier le nom de l'environnement dans le fichier ee-shared-env.yml. Vous pouvez également utiliser la commande remove de conda ou l'indicateur --clone de la commande create de conda pour gérer les noms d'environnement.

Remarque :La réplication d'environnements entre les systèmes d'exploitation peut échouer, car il existe des versions et des builds de packages spécifiques à l'OS qui peuvent ne pas être disponibles ou créer des conflits de dépendances.