La API de Earth Engine Python se puede instalar en una máquina local a través de conda, un administrador de paquetes y entornos de Python. Conda se incluye con Anaconda y Miniconda distribuciones de Python. 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 y trabajar con la API de Earth Engine. Si no estás familiarizado con estas distribuciones, visita sus vínculos para obtener más información.
En esta guía, se te indicará cómo hacer lo siguiente:
- Verificar si hay una instalación de conda existente
- Instalar conda en una máquina local
- Instalar la API de Earth Engine Python
- Configurar las credenciales de autenticación
- Probar la API
Verifica la instalación de conda
Si conda ya está instalado en tu sistema, ve a la sección Instala la API. Si no estás seguro de si conda está instalado, verifica ingresando el siguiente comando en tu interfaz de línea de comandos.
conda --help
Si conda está instalado y su ruta 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 Instala la API. Si no se reconoce conda, el resultado dirá algo como: conda no se encontró o no se reconoció 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, para mantener la coherencia, por favor continúa con la sección Instala conda, ya que es difícil abordar todas las configuraciones posibles del sistema. Mientras la carpeta “miniconda3” no exista en tu carpeta principal, las siguientes instrucciones de instalación de conda deberían completarse correctamente. Para obtener más información sobre la ubicación y el registro de la instalación de conda, consulta las páginas Instalación de Miniconda e Instalación de Anaconda.
Instala conda
En esta sección, descargarás e instalarás Miniconda, que servirá 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 alterar las variables de entorno del sistema. Si prefieres Anaconda, consulta las instrucciones de instalación que se proporcionan aquí y, luego, ve a la sección Instala 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 da como resultado 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, acepta los valores predeterminados en tu directorio principal.
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 completa del sistema. Una prueba exitosa dará como resultado que el contenido de ayuda de conda aparezca 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 con una simple llamada a conda sin tener que ejecutar primero el comando activate por su ruta completa. En las siguientes instrucciones, se explica cómo agregar la instalación de Miniconda a la variable PATH de tu sistema.
Linux
Para agregar la siguiente ruta a tu variable de entorno “PATH”, completa 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 tu 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 conda al archivo ~/.bashrc.
printf '\n# add path to conda\nexport PATH="$HOME/miniconda3/bin:$PATH"\n' >> ~/.bashrc
Mac
Para agregar la siguiente ruta a tu variable de entorno “PATH”, completa 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 tu 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 conda al archivo ~/.bashrc.
printf '\n# add path to conda\nexport PATH="$HOME/miniconda3/bin:$PATH"\n' >> ~/.bashrc
Windows
Para agregar la siguiente ruta a tu variable de entorno “Path”, completa 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 “Path” en la sección “Usuario” para seleccionarla para 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 existente de la variable “Path”. Asegúrate de que los puntos y comas (;) rodeen la entrada 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. En un símbolo del sistema, ingresa lo siguiente:
setx Path "%Path%%UserProfile%\miniconda3\condabin;"
Inicializa conda
Inicializa conda para la interacción con la shell. Ejecuta el comando anterior para obtener información sobre la inicialización de varias 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 base de conda con el siguiente comando.
conda activate
Instala la API
La API de Python de Earth Engine se distribuye como un paquete de conda-forge en
https://anaconda.org/conda-forge/earthengine-api.
Se instala con el comando conda install. Sin embargo, antes de la instalación, crea un entorno de conda específicamente para Earth Engine.
Instalar la API de Earth Engine en su propio entorno garantiza que ella 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 la administración de entornos de conda, por favor
visita este sitio.
1. Activa tu entorno base de conda, si aún no lo está.
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 sale bien, ahora tendrás un entorno de conda
llamado 'ee' con todos los requisitos para acceder a la API, así como
la earthengine herramienta de línea de comandos.
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 earthengine.
Dentro de tu entorno ee de conda, ejecuta el siguiente comando y sigue las instrucciones impresas resultantes. Se proporcionará una URL que generará un código de autorización cuando se acepte. Copia el código de autorización y, luego, ingrésalo como entrada de línea de comandos.
earthengine authenticate
Cuando ingreses el código de autorización, se guardará un token de autorización en un archivo de credenciales que se puede encontrar 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 deseas revocar la autorización, 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 simple de Python que imprima metadatos para un conjunto de datos DEM para probar la instalación de la API. Debería imprimir un objeto JSON en la consola.
1. Inicia un intérprete de 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 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 desees 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 su uso en la shell o no. Sigue las instrucciones pertinentes para tu instalación de conda que se indican a continuación.
Conda no registrado
En el siguiente comando de activación del entorno ee de conda, se supone que conda se instaló siguiendo las instrucciones de la sección Instala conda anterior, es decir, se supone la ruta de instalación según los 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 ee de conda, se supone que conda se registró para su uso en la shell o el símbolo del sistema según 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.
Ahora estás listo para iniciar un intérprete de Python y acceder a la API de Earth Engine Python. Consulta la página de 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 ee a la versión más reciente de la API. Recuerda activar primero tu entorno ee de conda, si aún no está activo.
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 ee de conda y, luego, ingresa los siguientes comandos.
import ee print(ee.__version__)
Comparte tu entorno ee
Puede ser útil compartir tu entorno de conda Python con otras personas para obtener resultados reproducibles y replicables, en especial cuando instalaste paquetes adicionales de Python. Conda proporciona una manera conveniente para que otros 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 podrá replicar el entorno ejecutando el siguiente comando de conda.
conda env create -f path-to-ee-shared-env.yml