Commit 65b44dd9 authored by GOMEZ GALLEGOS MARIA CONCEPCION's avatar GOMEZ GALLEGOS MARIA CONCEPCION
Browse files

Update README.md

parent 57cb58f9
......@@ -23,8 +23,17 @@ La carpeta de Almacenamiento contiene dos subcarpetas.
![Almacenamiento](images-project/Almacenamiento.PNG "Carpeta Almacenamiento")
- datos_term\
En esta carpeta se almacena todo lo referente a las geomedianas, se divide en anuales, subanuales y multianuales. De momento en el cubito de datos solo están disponibles las **geomedianas anuales**, cada año está separado por carpetas y dentro de cada carpeta se encuentra:
- GM. En esta carpeta se almacena el archivo TIF de la geomediana.
- dcFiles. Contiene los archivos necesarios para el correcto funcionamiento del cubito de datos.
- Fuentes\
En esta carpeta se encuentran los **Scripts de Python** con los cuales se lleva a cabo la generación de productos del cubo de datos. Estos se comparten con el fin de que usuarios avanzados en tema de programación y uso de cubo de datos puedan tomar los scripts y analizarlos para crear a partir de ellos herramientas que les sean útiles para sus tareas.
## Proyecto en gitlab
Otro elemento necesario para instalar el Cubito de datos es el proyecto de geocubo-portable publicado en el gitlab institucional de INEGI. Se recomienda clonarlo con Git para tener las actualizaciones más recientes, sin embargo, basta con descargarlo.
Otro elemento necesario para instalar el Geocubo Portable es el proyecto de geocubo-portable publicado en el gitlab institucional de INEGI. Se recomienda clonarlo con Git para tener las actualizaciones más recientes, sin embargo, basta con descargarlo.\
Descargar el proyecto en formato **ZIP** y se sugiere sea almacenado y descompactado en la carpeta de “Documentos”.
![Descarga](images-project/Descargar_proyecto.png "Descargar prooyecto")
......@@ -36,7 +45,9 @@ El último elemento que se necesita es la imagen de docker que contiene todo el
https://drive.google.com/file/d/1oXSHo2mvRJW4043qwd9z9z-4ZC1873jK/view?usp=sharing
![Imagen_docker](images-project/Imagen_docker.png "Imagen docker")\
Este archivo tiene un formato **TAR** y un tamaño mayor a los 4 GB, por lo que su descarga puede demorar varios minutos, se sugiere sea almacenado en la carpeta de “Documentos” para facilitar su acceso más adelante.
Este archivo tiene un formato **TAR** y un tamaño mayor a los 4 GB, por lo que su descarga puede demorar varios minutos, se sugiere sea almacenado en la carpeta de “Documentos” para facilitar su acceso más adelante.\
Dar clic en el enlace para descargar la imagen de Docker. Aparecerá un mensaje en pantalla diciendo que se tiene un problema para visualizar el archivo, ignorar el mensaje y dar clic en download. Aparecerá otro mensaje y dar clic en download anyway. Se abrirá una ventana de explorador y seleccionar documentos. Se observa que en la parte de abajo a la izquierda se está descargando el archivo CubitoDatos.tar a nuestro equipo. Verificar que se haya descargado el archivo en la carpeta de mis documentos.
## Docker
Tecnología para la creación y uso de contenedores de linux; permite crear diferentes ambientes de trabajo para la ejecución de aplicaciones.
......@@ -51,47 +62,54 @@ https://hub.docker.com/editions/community/docker-ce-desktop-windows
El archivo pesa alrededor de 500MB por lo que demora un poco en descargarse.
# Instalación de Docker
### En Windows
#### 1. Una vez que se descargue el instalador de Docker, procedemos a su instalación haciendo doble clic sobre el archivo descargado para que inicie el asistente de instalación.
## En Windows
#### 1. Instalación
Una vez que se descargue el instalador de Docker, se procede a su instalación haciendo doble clic sobre el archivo descargado para que inicie el asistente de instalación.
#### 2. Se abrirá una ventana de instalación de Docker.\
#### 2. Se abrirá una ventana de instalación de Docker.
Comenzará a descargar los archivos necesarios para la instalación.\
![Descarga](images-project/Inst_Window1.png "Descarga")\
#### 3. Establecer todas las configuraciones por defecto o recomendadadas por el asistente de instalación, dar clic en el botón Ok.\
#### 3. Configuración
Establecer todas las configuraciones por defecto o recomendadadas por el asistente de instalación, dar clic en el botón Ok.\
![Configuracion](images-project/Inst_Window2.PNG "Configuracion")
#### 4. Continuará con la instalación.\
#### 4. Continuará con la instalación.
Descomprimir archivos.\
![Instalacion](images-project/Inst_Window3.png "Instalacion")\
#### 5. Finalizar instalación.\
#### 5. Finalizar instalación.
Dar clic en close and restart.\
![Close](images-project/Inst_Window4.png "Close")\
El asistente de instalación pedirá reiniciar el equipo al finalizar la instalación.\
Se creará un icono en el escritorio de Windows, dar clic en el icono de Docker.
### En Ubuntu
#### 1. Actualizar repositorios con el comando:\
#### 6. Probar Docker.
Para probar Docker, abrir una ventana de Windows Powershell y se ejecuta el siguiente comando:\
**docker info**
## En Ubuntu
#### 1. Actualizar repositorios con el comando:
**sudo apt update**\
![Actualizar_repositorios](images-project/Inst_Ubuntu1.png "Actualizar repositorios")\
Nota: Si el comando le pide que se actualicen paquetes del sistema operativo será necesario ejecutar el siguiente comando:\
**sudo apt-get upgrade**\
![Actualizar_paquetes](images-project/Inst_Ubuntu1a.png "Actualizar paquetes")\
Enseguida volver a ejecutar el comando update
#### 2. Instalar algunos paquetes que permiten a apt usar paquetes mediante https:\
Enseguida volver a ejecutar el comando update.
#### 2. Instalar algunos paquetes que permiten a apt usar paquetes mediante https:
**sudo apt install apt-transport-https ca-certificates curl software-properties-common**
![Instalar_paquetes](images-project/Inst_Ubuntu2.png "Instalar paquetes")\
#### 3. Agregar la clave GPG para el repositorio oficial de Docker a su sistema:\
#### 3. Agregar la clave GPG para el repositorio oficial de Docker a su sistema:
**curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add –**
![Agregar_clave](images-project/Inst_Ubuntu3.png "Agregar clave")\
#### 4. Agregar el positorio de Docker a las fuentes de apt:\
#### 4. Agregar el repositorio de Docker a las fuentes de apt:
**sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable"**
![Agregar_repositorio](images-project/Inst_Ubuntu4.png "Agregar repositorio")\
#### 5. Actualizar la base de datos de paquetes usando los paquetes de Docker del repositorio que se acaba de Agregar:\
#### 5. Actualizar la base de datos de paquetes usando los paquetes de Docker del repositorio que se acaba de Agregar:
**sudo apt update**
#### 6. Instalar Docker:\
#### 6. Instalar Docker:
**sudo apt install docker-ce**\
![Instalar_docker](images-project/Inst_Ubuntu6.png "Instalar docker")\
#### 7. Verificar que se esté ejecutando:\
#### 7. Verificar que se esté ejecutando:
**sudo systemctl status docker**\
![Verificiar_docker](images-project/Inst_Ubuntu7.png "Verificar docker")\
De forma predeterminada, el comando docker solo se puede ejecutar por el usuario de root o por un usuario perteneciente al grupo docker, el cual se creó durante la instalación de Docker. Si intenta ejecutar el comando docker sin el prefijo sudo o sin estar en el grupo docker, en la consola se mostrará un mensaje como el siguiente:\
......@@ -101,51 +119,60 @@ Para agregar su nombre de usuario al grupo docker y así evitar escribir sudo an
Para aplicar la nueva membresía de grupo, debe cerrar sesión en el servidor y volver a iniciarla, o puede ejecutar lo siguiente:\
**su - ${USER}**\
![Membresia_grupo](images-project/Inst_Ubuntu7a.png "Membresia grupo")\
#### 8. Para probar que todo funciona correctamente, ejecutar el siguiente comando para obtener información de Docker en su sistema:\
#### 8. Probar que todo funciona correctamente.
Ejecutar el siguiente comando para obtener información de Docker en su sistema:\
**docker info**\
![Informacion](images-project/Inst_Ubuntu8.png "Informacion")\
#### 9. Instalación de una utilería de Docker para hacer usar correctamente el Geocubo Portable. Ejecutar el siguiente comando:\
#### 9. Instalación de una utilería de Docker para hacer usar correctamente el Geocubo Portable.
Ejecutar el siguiente comando:\
**sudo apt install docker-compose**\
![Utileria_docker](images-project/Inst_Ubuntu9.png "Utileria docker")\
# Ejecutar el software en nuestro equipo
El Geocubo portable requerie el uso de contenedores y microservicios que se ejecutan a través de la consola de comandos PowerShell.\
Añadir la imagen al repositorio de nuestro Docker local que es la imagen de docker que se descargó desde el inicio de este manual, que tiene un tamaño aproximado de 4GB. Dicha imagen contiene la instalación de todas las librerías que se requieren para el correcto funcionamiento del Geocubo Portable.
1. Abrir una terminal en Linux o una consola de Windows Power Shell.
#### 1. Abrir una terminal en Linux o una consola de Windows Power Shell.
2. Colocarse en la ubicación donde se descargó la imagen:\
#### 2. Colocarse en la ubicación donde se descargó la imagen:
**cd .\Documents**
3. Añadir la imagen con el siguiente comando:\
#### 3. Añadir la imagen con el siguiente comando:
**docker load -i .\CubitoDatos.tar**\
Este paso puede tardar algunos minutos, pero una vez que termine se puede ver que se agregó a la lista de imágenes en docker a través del siguiente comando:\
**docker image ls**\
![Imagen_load](images-project/Imagen_load.png "Imagen añadida")\
4. Verificar el archivo docker-compose.yml que se encuentra en la raíz.\
Para continuar con el proceso de instalación del GeoCubo Portable, es necesario modificar el archivo docker-compose.yml que se encuentra en la raíz del proyecto que se descargó de gitlab previamente. Las líneas a revisar se encuentran señaladas en la siguiente imagen:\
#### 4. Verificar el archivo docker-compose.yml.
Para continuar con el proceso de instalación del GeoCubo Portable, es necesario revisar y en su caso modificar el archivo docker-compose.yml que se encuentra en la raíz del proyecto que se descargó de gitlab previamente. Las líneas a revisar se encuentran señaladas en la siguiente imagen:\
![Archivo](images-project/Archivo_yml.png "Archivo")\
Nota: Si estas en el sistema operativo de Windows y la carpeta Almacenamiento la tienes ubicada en C:/, la raíz del sistema, no es necesario que hagas ninguna modificación en el archivo antes mencionado y puedes continuar con el siguiente paso, resaltado en negritas en la siguiente pagina.
5. Moverse a la ubicación del proyecto:\
#### 5. Moverse a la ubicación del proyecto:
cd '.\Documents\datacube-inegi-on-docker\'\
En caso de que recién ejecutarás Power Shell, si continuas con la misma ventana con la que cargaste la imagen de docker es con el siguiente comando:\
cd 'datacube-inegi-on-docker\'
6. Activar e iniciar tareas de los contenedores de Docker con el siguiente comando:\
#### 6. Crear/Iniciar los contenedores.
Activar e iniciar tareas de los contenedores de Docker con el siguiente comando:
**docker-compose up -d**\
![Activar_contenedores](images-project/Docker_compuse.png "Activar contenedores")\
Una vez que se haya ejecutado el comando los contenedores de Docker para el Geocubo Portable estarán activos e iniciando sus tareas, se podrán monitorear desde el Dashboard.
#### Detener los contenedores.
Instrucción para detener contenedores:\
**docker-compose stop**
# Iniciar un cuaderno de Jupyter
Es una herramienta que nos permite ejecutar un código en Python al mismo tiempo que se va explicando.
1. Iniciar contenedor.\
Si el contenedor con el Cubito de Datos ya se encuentra disponible en su equipo, pero no se está ejecutando, es necesario que desde una terminal en Linux o una consola de Power Shell de Windows, se ubiquen en la raíz del proyecto de gitlab y se ejecute el siguiente comando:\
**docker-compose up –d**
2. Iniciar cuaderno de Jupyter.\
#### 1. Iniciar contenedor.
Si el contenedor con el Geocubo Portable ya se encuentra disponible en su equipo, pero no se está ejecutando, es necesario que desde una terminal en Linux o una consola de Power Shell de Windows, se ubiquen en la raíz del proyecto de gitlab y se ejecute el siguiente comando:\
**docker-compose up –d**\
-d es importante porque manda el proceso a segundo plano, indica que la base de datos está iniciada y el datacube está iniciado. Podemos salirnos o cerrar la consola y el Geocubo se está ejecutando.
#### 2. Iniciar cuaderno de Jupyter.
Para poder iniciar el cuaderno de descargas habrá que acceder al siguiente link desde cualquier navegador web:\
http://127.0.0.1:8888/?token=
Al ingresar al sitio se solicita una contraseña, es la siguiente: **datacubeOnDocker**\
Página web:\
![Jupyter](images-project/Jupyter.png "Inicio Jupyter")\
En la ventana se muestra como un explorador de archivos, donde se pueden crear o consultar cuadernos de Jupyter con código que interactúe directamente con el GeoCubo Portable.
2. Descargar imágenes.\
#### 2. Descargar imágenes.
El Geocubo Portable requiere de imágenes para poder hacer las consultas de los cuadernos, estás imágenes se almacenen en la carpeta Almacenamiento que se presentó al principio de este manual, sin embargo, de inicio la carpeta no contiene ninguna imagen y será necesario ejecutar el cuaderno para descargas de imágenes.\
La carpeta **Descargas** contiene el cuaderno que se debe iniciar para la **descarga de imágenes**. El cuaderno está listo para descargar las imágenes que comprenden al estado de Aguascalientes, basta con abrirlo y seguir las instrucciones.\
![Jupyter](images-project/Jupyter2.png "Inicio Jupyter")\
......@@ -167,7 +194,7 @@ En Ubuntu:\
Enlace de los archivos:\
https://365inegi-my.sharepoint.com/:u:/g/personal/armando_soto_inegi_org_mx/EUCDJvuGzT1IthITNvd7uZgBMY6ciD8eY0dUwcSKPAOtnA?e=D0Q4Sg
- En caso de sustituir los archivos y aún continuar con problemas, favor de contactar a los creadores del proyecto.
### 4. En caso de obtener un error como el que se muestra en la imagen:\
### 4. En caso de obtener un error como el que se muestra en la imagen:
![Error](images-project/Error3.png "Error")\
El error es:\
ERROR: for datacube-inegi-on-docker_datacube_db_1 Cannot create container for service datacube_db: status code not OK but 500:\
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment