Installation de NPM

L'API JavaScript Earth Engine est distribuée sous forme de package npm qui est hébergé sur GitHub. Les instructions suivantes donnent un aperçu de l'installation de l'API JavaScript Google Earth Engine. Pour utiliser l'API JavaScript Earth Engine, vous devez installer la bibliothèque cliente et ses dépendances sur votre ordinateur, puis configurer les identifiants d'authentification.

La bibliothèque cliente JavaScript n'inclut pas toutes les fonctionnalités de l'éditeur de code Earth Engine Code Editor. En particulier, les fonctionnalités d'interface utilisateur telles que les boutons, les panneaux et les graphiques sont exclues.

Installer la bibliothèque cliente

1. Configurer Node.js et npm

npm est un gestionnaire de paquets pour JavaScript et Node.js. Vérifiez que vous disposez de Node.js 6 ou version ultérieure et de npm 3 ou version ultérieure.

node --version
npm --version

Si nécessaire, installez les deux à l'aide du programme d'installation officiel pour votre plate-forme.

2. Installer la bibliothèque cliente Earth Engine

La bibliothèque cliente peut être installée à partir de npm à l'aide de la commande suivante :

npm install --save @google/earthengine

Une fois installée, la bibliothèque cliente est placée dans le répertoire du projet actuel : node_modules/@google/earthengine/*. Pour les futurs projets, installez le client de la même manière.

3. Utiliser la bibliothèque cliente dans une application

Dans le code de votre application, exigez l'API Earth Engine :

var ee = require('@google/earthengine');

Mettre à jour la bibliothèque cliente

Utilisez npm pour mettre à jour la bibliothèque cliente vers la dernière version. Depuis le répertoire du projet actuel : 
npm update @google/earthengine

En savoir plus sur la mise à jour des bibliothèques avec npm.

Désinstaller la bibliothèque cliente

Pour désinstaller à l'aide du gestionnaire de paquets npm, exécutez la commande suivante :

npm uninstall --save @google/earthengine

Cette commande supprime node_modules/@google/earthengine du projet actuel, mais n'affecte aucun projet dans d'autres répertoires de la même machine.

Créer un projet Cloud et activer l'API Earth Engine

Suivez ces instructions pour créer un projet Cloud et activer l'API Earth Engine.

Configurer les identifiants d'authentification

Les API Earth Engine utilisent le protocole OAuth 2.0 pour authentifier les clients basés sur un navigateur. Pour l'authentification côté serveur dans Node.js, nous vous recommandons d'utiliser des comptes de service. Les applications Web peuvent utiliser l'une ou l'autre approche, avec les avantages et les inconvénients décrits ci-dessous.

Authentification côté client avec OAuth

Avec l'authentification côté client dans un navigateur Web, les utilisateurs de votre application se connectent avec leur propre compte Google. Ces utilisateurs doivent déjà être autorisés à accéder à Earth Engine et doivent être autorisés à lire les éléments utilisés par votre application.

Après avoir créé un ID client OAuth 2.0, authentifiez-vous comme indiqué ci-dessous (remplacez my-project par l'ID de votre projet Google Cloud) :

// Load client library.
var ee = require('@google/earthengine');

// Initialize client library and run analysis.
var initialize = function() {
  ee.initialize(null, null, function() {
    // ... run analysis ...
  }, function(e) {
    console.error('Initialization error: ' + e);
  }, null, 'my-project');
};

// Authenticate using an OAuth pop-up.
ee.data.authenticateViaOauth(YOUR_CLIENT_ID, initialize, function(e) {
  console.error('Authentication error: ' + e);
}, null, function() {
  ee.data.authenticateViaPopup(initialize);
});

Authentification côté serveur avec un compte de service

Avec l'authentification côté serveur, une clé privée est stockée avec votre application, ce qui lui permet d'accéder à l'API Earth Engine via un compte de service. Les utilisateurs de votre application n'ont pas besoin de leur propre accès à Earth Engine et ne sont pas tenus de se connecter.

Dans Node.js, seule l'authentification côté serveur est fournie par la bibliothèque cliente.

Après avoir créé un compte de service, utilisez votre clé privée JSON pour vous authentifier (remplacez my-project par l'ID de votre projet Google Cloud) :

// Require client library and private key.
var ee = require('@google/earthengine');
var privateKey = require('./.private-key.json');

// Initialize client library and run analysis.
var runAnalysis = function() {
  ee.initialize(null, null, function() {
    // ... run analysis ...
  }, function(e) {
    console.error('Initialization error: ' + e);
  }, null, 'my-project');
};

// Authenticate using a service account.
ee.data.authenticateViaPrivateKey(privateKey, runAnalysis, function(e) {
  console.error('Authentication error: ' + e);
});

Tester l'installation

Pour vérifier que l'authentification a été configurée correctement, exécutez le script suivant (remplacez my-project par l'ID de votre projet Google Cloud) :

var ee = require('@google/earthengine');

// Authenticate using one (but not both) of the methods below.
ee.data.authenticateViaOauth(YOUR_CLIENT_ID);
ee.data.authenticateViaPrivateKey(YOUR_PRIVATE_KEY);

ee.initialize(null, null, null, null, null, 'my-project');

// Run an Earth Engine script.
var image = new ee.Image('srtm90_v4');
image.getMap({min: 0, max: 1000}, function(map) {
  console.log(map);
});

Si tout est installé correctement, les métadonnées d'une image doivent être imprimées.