L'API Python Earth Engine peut être installée sur une machine locale via conda, un gestionnaire de packages et d'environnements Python. Conda est fourni avec Anaconda et Miniconda les distributions Python. Anaconda est une plate-forme de programmation de science des données qui inclut plus de 1 500 packages, tandis que Miniconda n'inclut que conda et ses dépendances. Ces deux distributions Python conviennent 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 si conda est déjà installé
- Installer conda sur une machine locale
- Installer l'API Python Earth Engine
- Configurer les identifiants d'authentification
- Tester l'API
Vérifier si conda est installé
Si conda est déjà installé sur votre système, passez à la section Installer l'API. Si vous n'êtes pas sûr que conda soit installé, vérifiez-le 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 d'aide de conda doit s'afficher dans le terminal. Si le contenu d'aide s'affiche, passez à la section Installer l'API. Si conda n'est pas reconnu, le résultat sera semblable à : conda not found or not recognized as a command (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 dans ce cas, pour plus de cohérence, veuillez continuer avec la section Installer conda, car il est difficile de traiter toutes les configurations système possibles. Tant que le dossier "miniconda3" n'existe pas dans votre dossier d'accueil, les instructions d'installation de conda suivantes devraient fonctionner. Pour en savoir plus sur l'emplacement d'installation et l'enregistrement de conda, veuillez consulter les pages Installation de Miniconda et Installation d'Anaconda.
Installer conda
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, mais pour minimiser l'impact sur votre système, ce guide décrit une installation de 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 s'effectuent en trois étapes :
- Téléchargez le programme d'installation Miniconda Python 3 64 bits dans votre répertoire d'accueil.
- Exécutez le programme d'installation.
- Supprimez 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. L'installation crée un dossier nommé "miniconda3" dans 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 en mode silencieux, 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 de 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 de 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
Ajouter Miniconda à la variable PATH
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 en appelant simplement 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 de 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 l'interface graphique ou de la ligne de commande ci-dessous.
$HOME/miniconda3/bin
GUI
1. Ouvrez le fichier .bashrc situé dans votre répertoire $HOME dans un éditeur de texte.
xdg-open ~/.bashrc
2. Copiez et collez les lignes suivantes au bas du fichier.
# add path to conda export PATH="$HOME/miniconda3/bin:$PATH"
3. Enregistrez le fichier et fermez l'éditeur.
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 l'interface graphique ou de la ligne de commande ci-dessous.
$HOME/miniconda3/bin
GUI
1. Ouvrez le fichier .bashrc situé dans votre répertoire $HOME dans un éditeur de texte.
touch ~/.bashrc; open -t ~/.bashrc
2. Copiez et collez les lignes suivantes au bas du fichier.
# add path to conda export PATH="$HOME/miniconda3/bin:$PATH"
3. Enregistrez le fichier et fermez l'éditeur.
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 l'interface graphique ou de la ligne de commande ci-dessous.
%UserProfile%\miniconda3\condabin
GUI
1. Saisissez la ligne suivante dans une invite de commandes pour ouvrir la boîte de dialogue "Variable d'environnement".
rundll32 sysdm.cpl,EditEnvironmentVariables
2. Double-cliquez sur la variable "Path" dans la section "User" (Utilisateur) pour la sélectionner et la modifier.
3. Cliquez sur le bouton "Edit text" (Modifier le texte) dans la nouvelle boîte de dialogue "Edit" (Modifier) pour ouvrir l'éditeur.
4. Ajoutez la chaîne suivante à la fin de la valeur de la variable "Path" existante. Assurez-vous que des points-virgules (;) entourent l'entrée 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.
Ligne de commande
Utilisez la commande setx pour ajouter le chemin d'accès. Dans une invite de commandes, saisissez :
setx Path "%Path%%UserProfile%\miniconda3\condabin;"
Initialiser conda
Initialisez conda pour l'interaction avec le shell. Exécutez la commande suivante pour obtenir des informations sur l'initialisation de différents shells. Suivez les instructions qui s'affichent dans la console après avoir saisi 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.
Elle est installée avec la commande conda install. Avant de l'installer, créez un environnement conda spécifiquement pour Earth Engine.
L'installation de l'API Earth Engine dans son propre environnement garantit qu'elle et ses packages dépendants ne provoqueront pas de problèmes de gestion des versions avec votre environnement de base ou tout autre environnement que vous avez configuré précédemment, et vice versa. Pour en savoir plus sur la gestion des environnements conda, veuillez
consulter ce site.
1. Activez votre environnement conda de base, s'il ne l'est pas déjà.
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 serez 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) s'affiche 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 serez 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 disposerez désormais d'un environnement conda
appelé 'ee' avec toutes les exigences d'accès à l'API, ainsi que
de l'earthengine outil de ligne de commande.
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. Une URL sera fournie et générera un code d'autorisation une fois que vous l'aurez acceptée. Copiez le code d'autorisation et saisissez-le comme entrée de 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 recherchera ce fichier pour s'authentifier. Si vous souhaitez révoquer l'autorisation, supprimez simplement 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 conda ee.
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 conda ee. La procédure d'activation dépend de si conda est enregistré pour une utilisation dans le shell ou non. Suivez les instructions correspondant à votre installation de conda ci-dessous.
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é en fonction des é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 une utilisation dans le shell ou l'invite de commandes 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 conda ee, 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 répliquer 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 répertorie 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 pourra répliquer l'environnement en exécutant la commande conda suivante.
conda env create -f path-to-ee-shared-env.yml