La API de Python para Earth Engine se puede instalar en una máquina local a través de conda, un administrador de paquetes y entornos de Python. Conda se incluye en las distribuciones de Python de Anaconda y Miniconda. Anaconda es una plataforma de programación de ciencia de datos que incluye más de 1,500 paquetes, mientras que Miniconda solo incluye conda y sus dependencias. Cualquiera de estas distribuciones de Python es adecuada para instalar la API de Earth Engine y trabajar con ella. Si no conoces estas distribuciones, visita sus vínculos para obtener más información.
En esta guía, se te indicará lo siguiente:
- Cómo verificar si hay una instalación de conda existente
- Cómo instalar conda en una máquina local
- Instala la API de Python de Earth Engine
- Configura las credenciales de autenticación
- Pruebe la API
Cómo verificar la instalación de conda
Si conda ya está instalado en tu sistema, ve a la sección Cómo instalar la API. Si no sabes si conda está instalado, verifica ingresando el siguiente comando en la interfaz de línea de comandos.
conda --help
Si conda está instalado y su ruta de acceso del sistema está registrada en la variable de entorno PATH, el contenido de ayuda de conda debería aparecer en la terminal. Si aparece el contenido de ayuda, ve a la sección Cómo instalar la API. Si no se reconoce conda, el resultado dirá algo como No se encontró conda o no se reconoce como un comando. Es posible que el programa exista en tu sistema, pero no esté registrado en la variable de entorno PATH. Incluso si este es el caso, por coherencia, continúa con la sección Cómo instalar conda, ya que es difícil abordar todas las configuraciones de sistema posibles. Siempre que la carpeta "miniconda3" no exista en tu carpeta Home, las siguientes instrucciones de instalación de conda deberían tener éxito. Para obtener más información sobre la ubicación de instalación y el registro de conda, consulta las páginas Instalación de Miniconda y Instalación de Anaconda.
Instala conda
En esta sección, descargarás e instalarás Miniconda, que funcionará como la plataforma de Python para acceder a la API de Earth Engine. Como se describió anteriormente, puedes usar Miniconda o Anaconda, pero para minimizar el impacto en tu sistema, en esta guía se describirá una instalación de Miniconda sin alteraciones en las variables de entorno de tu sistema. Si prefieres Anaconda, consulta las instrucciones de instalación que se proporcionan aquí y, luego, ve a la sección Cómo instalar la API.
Instala Miniconda
La descarga y la instalación de Miniconda se realizan en tres pasos:
- Descarga el instalador de Miniconda de Python 3 de 64 bits en tu directorio principal.
- Ejecuta el instalador
- Borra el instalador
Para completar estos pasos, copia y pega las siguientes líneas en la interfaz de línea de comandos adecuada para tu sistema. La instalación genera una carpeta llamada “miniconda3” que se agrega a tu directorio principal.
1. Descarga el instalador de Miniconda en tu directorio principal.
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. Instala Miniconda de forma silenciosa, aceptando los valores predeterminados, en tu directorio de inicio.
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. Quita el instalador de Miniconda de tu directorio principal.
Linux
rm ~/miniconda.sh
Mac
rm ~/miniconda.sh
Windows
del %UserProfile%\miniconda.exe
Prueba la instalación de Miniconda
Imprime el menú de ayuda del comando conda
para probar la instalación de Miniconda.
Como Miniconda no se agregó a la variable de entorno PATH de tu sistema, primero deberás activar conda para esta sesión llamando al comando activate
por su ruta de acceso completa del sistema. Si la prueba es exitosa, el contenido de ayuda de conda
aparecerá en la terminal. Ejecuta las siguientes líneas en la interfaz de línea de comandos de tu sistema.
Linux
source $HOME/miniconda3/bin/activate conda --help
Mac
source $HOME/miniconda3/bin/activate conda --help
Windows
%UserProfile%\miniconda3\condabin\activate conda --help
Agrega Miniconda a la variable PATH
De manera opcional, puedes agregar la ruta de instalación de Miniconda a la variable PATH de tu sistema, lo que te permitirá interactuar con conda mediante una simple llamada a conda
sin tener que ejecutar primero el comando activate
por su ruta de acceso completa. En las siguientes instrucciones, se explica cómo agregar la instalación de Miniconda a la variable PATH de tu sistema.
Linux
Agrega la siguiente ruta de acceso a tu variable de entorno "PATH" completando las instrucciones de la GUI o de la línea de comandos que se indican a continuación.
$HOME/miniconda3/bin
GUI
1. Abre el archivo .bashrc
que se encuentra en el directorio $HOME
en un editor de texto.
xdg-open ~/.bashrc
2. Copia y pega las siguientes líneas en la parte inferior del archivo.
# add path to conda export PATH="$HOME/miniconda3/bin:$PATH"
3. Guarda el archivo y cierra el editor de texto.
Línea de comandos
Ingresa el siguiente comando en una terminal para agregar la ruta de acceso de conda al archivo ~/.bashrc
.
printf '\n# add path to conda\nexport PATH="$HOME/miniconda3/bin:$PATH"\n' >> ~/.bashrc
Mac
Agrega la siguiente ruta de acceso a tu variable de entorno "PATH" completando las instrucciones de la GUI o de la línea de comandos que se indican a continuación.
$HOME/miniconda3/bin
GUI
1. Abre el archivo .bashrc
que se encuentra en el directorio $HOME
en un editor de texto.
touch ~/.bashrc; open -t ~/.bashrc
2. Copia y pega las siguientes líneas en la parte inferior del archivo.
# add path to conda export PATH="$HOME/miniconda3/bin:$PATH"
3. Guarda el archivo y cierra el editor de texto.
Línea de comandos
Ingresa el siguiente comando en una terminal para agregar la ruta de acceso de conda al archivo ~/.bashrc
.
printf '\n# add path to conda\nexport PATH="$HOME/miniconda3/bin:$PATH"\n' >> ~/.bashrc
Windows
Agrega la siguiente ruta de acceso a la variable de entorno "Path" completando las instrucciones de la GUI o de la línea de comandos que se indican a continuación.
%UserProfile%\miniconda3\condabin
GUI
1. Ingresa la siguiente línea en un símbolo del sistema para abrir el diálogo "Variable de entorno".
rundll32 sysdm.cpl,EditEnvironmentVariables
2. Haz doble clic en la variable "Ruta de acceso" en la sección "Usuario" para seleccionarla y editarla.
3. Haz clic en el botón "Editar texto" en la nueva ventana de diálogo "Editar" para abrir el editor.
4. Agrega la siguiente cadena al final del valor de la variable "Ruta" existente. Asegúrate de que la entrada esté rodeada de punto y coma (;) para distinguirla de las entradas vecinas.
%UserProfile%\miniconda3\condabin;
5. Haz clic en los botones "Aceptar" hasta que se cierren todas las ventanas de diálogo.
Línea de comandos
Usa el comando setx
para agregar la ruta de acceso. En un símbolo del sistema, ingresa lo siguiente:
setx Path "%Path%%UserProfile%\miniconda3\condabin;"
Inicializa conda
Inicializa conda para la interacción de shell. Ejecuta el comando que se indica a continuación para obtener información sobre la inicialización de varios shells. Sigue las instrucciones posteriores que se imprimen en la consola cuando ingresas el comando.
conda init --help
Después de reiniciar la interfaz de línea de comandos, deberías poder activar el entorno de conda base con el siguiente comando.
conda activate
Instala la API
La API de Python para Earth Engine se distribuye como un paquete conda-forge en https://anaconda.org/conda-forge/earthengine-api.
Se instala con el comando conda install
. Sin embargo, antes de instalarlo, crea un entorno de conda específicamente para Earth Engine.
Instalar la API de Earth Engine en su propio entorno garantiza que esta y sus paquetes dependientes no causen problemas de control de versiones con tu entorno base ni con ningún otro entorno que hayas configurado anteriormente, y viceversa. Para obtener más información sobre cómo administrar entornos de conda, visita
este sitio.
1. Activa tu entorno de conda base, si aún no lo has hecho.
Linux
source $HOME/miniconda3/bin/activate
Mac
source $HOME/miniconda3/bin/activate
Windows
%UserProfile%\miniconda3\condabin\activate
2. Crea un entorno virtual de conda para la API de Earth Engine.
conda create --name ee
Se te pedirá que confirmes la creación del entorno. Hazlo.
3. Activa el entorno ee de conda.
conda activate ee
4. Instala la API en el entorno ee de conda. Asegúrate de que (ee)
aparezca al comienzo de la línea de comandos, lo que indica que estás trabajando desde el entorno ee.
conda install -c conda-forge earthengine-api
Se te pedirá que confirmes la instalación de la API y sus dependencias. Después de confirmar, conda descargará e instalará las dependencias. Si todo va bien, ahora tendrás un entorno conda llamado "ee" con todos los requisitos para acceder a la API, así como la herramienta de línea de comandos earthengine
.
Obtén credenciales
Antes de usar la API de Earth Engine o la herramienta de línea de comandos earthengine
, debes realizar una autenticación única que autorice el acceso a Earth Engine en nombre de tu Cuenta de Google. Para autenticarte, usa el comando authenticate
de la herramienta de línea de comandos de earthengine
.
En tu entorno de conda ee, ejecuta el siguiente comando y sigue las instrucciones impresas que se muestran. Se proporcionará una URL que generará un código de autorización una vez que se firme el acuerdo. Copia el código de autorización y, luego, ingrésalo como entrada de línea de comandos.
earthengine authenticate
Cuando ingresas el código de autorización, se guarda un token de autorización en un archivo de credenciales que se encuentra a continuación. El uso posterior del comando ee.Initialize()
de la API y la herramienta de línea de comandos earthengine
buscarán este archivo para autenticarse. Si quieres revocar la autorización, simplemente borra el archivo de credenciales.
Linux
ls $HOME/.config/earthengine/credentials
Mac
ls $HOME/.config/earthengine/credentials
Windows
dir %UserProfile%\.config\earthengine\credentials
Pruebe la API
Ejecuta una secuencia de comandos de Python simple que imprima metadatos para un conjunto de datos de DEM para probar la instalación de la API. Debería imprimir un objeto JSON en la consola.
1. Inicia un intérprete python
desde tu entorno ee de conda.
python
2. Ejecuta las siguientes líneas de Python una por una para imprimir los metadatos de un conjunto de datos de DEM.
import ee # Initialize the Earth Engine module. ee.Initialize() # Print metadata for a DEM dataset. print(ee.Image('USGS/SRTMGL1_003').getInfo())
Uso posterior de la API
Cada vez que quieras usar la API de Earth Engine, primero debes activar tu entorno ee de conda. El procedimiento de activación depende de si conda está registrado para usarse en la shell o no. Sigue las instrucciones relevantes para tu instalación de conda que se indican a continuación.
Conda no está registrado
En el siguiente comando de activación del entorno ee de conda, se supone que se instaló conda siguiendo las instrucciones de la sección Cómo instalar conda anterior, es decir, se supone que la ruta de instalación se basa en pasos anteriores. Ejecuta el siguiente comando en una interfaz de línea de comandos.
Linux
source $HOME/miniconda3/bin/activate ee
Mac
source $HOME/miniconda3/bin/activate ee
Windows
%UserProfile%\miniconda3\condabin\activate ee
Conda registrado
En el siguiente comando de activación del entorno conda ee, se supone que conda se registró para usar en la shell o el mensaje de comandos mediante las instrucciones de esta guía o por otros medios. Ejecuta el siguiente comando en una interfaz de línea de comandos.
conda activate ee
Después de ejecutar el comando, deberías ver (ee)
al comienzo de la línea de comandos, lo que indica que estás trabajando desde el entorno ee.
Ya puedes iniciar un intérprete de Python y acceder a la API de Earth Engine para Python. Consulta la página Instalación de Python para obtener orientación general sobre cómo trabajar con la API de Python.
Actualiza la API
Usa el comando conda update
para actualizar tu entorno de ee a la versión más reciente de la API. Recuerda activar primero tu entorno ee de conda, si aún no lo has hecho.
conda update -c conda-forge earthengine-api
Para obtener el número de versión instalado actualmente en Python, imprime la propiedad __version__
de la biblioteca ee
. Para iniciar un intérprete de Python, ingresa python
en la línea de comandos del entorno de conda ee y, luego, ingresa los siguientes comandos.
import ee print(ee.__version__)
Cómo compartir tu entorno de ee
Puede ser útil compartir tu entorno de Python de conda con otras personas para lograr resultados reproducibles, en especial cuando instalaste paquetes de Python adicionales. Conda proporciona una forma conveniente para que otras personas repliquen tu entorno.
Desde tu entorno ee de conda, ejecuta el siguiente comando para guardar un archivo YAML llamado "ee-shared-env" en tu directorio principal, que enumera las especificaciones de tu entorno.
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
Comparte el archivo resultante y el destinatario puede replicar el entorno ejecutando el siguiente comando de conda.
conda env create -f path-to-ee-shared-env.yml