Tutorial para la Interfaz de SWIM
Versión del programa: 0.8 – Fase Beta
Revisión del documento: 7
Fecha de creación: 31 de Julio de 2017
Fecha de modificación: 26 de Julio del 2018
Creador: Luis Garnica
El propósito de este documento es proporcionar una guia paso a paso para la interfaz de usuario de SWIM. Este documento contiene: cómo obtener acceso a la interfaz de usuario, opciones de la pantalla de inicio, cómo crear un escenario personalizado, acceso a ejecuciones previas, comparación entre escenarios y registrar un usuario.
Terminología
Término | Descripción |
---|---|
Escenario personalizado | Una especificación de entrada personalizada que compuesta de parámetros definidos por el usuario y metadatos de ejecución. |
Parámetro de entrada | Un valor que define datos de entrada para un modelo. |
Variable de salida | Una variable del modelo a la que se le ha asignado un valor después de la ejecución del mismo. |
Acceso a la interfaz de usuario
La interfaz de modelaje puede ser accesada directamente al abrir un navegador de internet y usando la siguiente dirección: https://water.cybershare.utep.edu/swim/home/es/. Alternativamente, también puede ser accesada desde la página de inicio del proyecto al seleccionar "Herramientas > Interfaz SWIM" en el menú principal.
Figura 01: Botón de Interfaz SWIM localizado en la barra de navegación del sitio público
Distribución de la Página de Inicio
Una vez que se obtiene acceso, la página mostrará una introducción breve del sistema y un resumen sobre los modelos actualmente implementados.
El menú principal de SWIM está compuesto de las siguientes secciones:
- Inicio: Redirige a la página de inicio del proyecto principal.
- Introducción: Introducción a la interfaz de modelaje.
- Crear escenario: Interfaz de usuario para la especificación, ejecución y visualización de resultados de un escenario.
- Escenarios públicos: Listado de todos los escenarios que han sido ejecutados y que están abiertos al público para consulta.
- Documentación: Sección web que documenta el sistema en general.
- Iniciar sesión: Inicio de sesión, registro de usuario y acceso a los escenarios previamente creados por el usuario.
Figura 02: Pantalla de inicio de la interfaz SWIM
Crear Escenario
El proceso para crear un escenario está dividido en cinco pasos para especificar, correr y visualizar el escenario ejecutado atraves de un modelo. El usuario tiene la opción de seleccionar un escenario predefinido en el paso 1 y directamente saltar al Paso 3, o adicionalmente personalizar parámetros en el Paso 2.
El proceso para crear un escenario personalizado se describe a continuación:
- Paso 1 – Escenarios: Selección de escenarios predefinidos de flujos de agua, política, población y tecnología.
- Paso 2 – Personaliza: Personalización de parámetros de entrada específicos.
- Paso 3 – Revisar y Corrida: Listado de parámetros y ejecución de modelos.
- Paso 4 – Resultados: Visualización de las variables de salida.
- Paso 5 – Procedencia: Rastro en el proceso de creación y visualización datos.
Figurea 03: Sección de escenarios
Paso 1: Escenarios
El propósito de este paso es seleccionar escenarios base que definen a un conjunto de parámetros de entrada.
Los escenarios disponibles están completamente iluminados y se pueden seleccionar, los escenarios que no están disponibles están descoloridos y deshabilitados. Cuando un escenario es seleccionado, un marco verde aparecerá en la imagen del escenario seleccionado.
Las combinaciones de escenarios estan divididas en múltiples categorías que permiten una personalización más avanzada, tales como:
- Flujos de Entrada: Selección de un escenario base de suministro de agua.
- Política: Selección de una propuesta política organizacional.
- Población: Ajuste en tendencias de crecimiento demográfico .
- Tecnología: Sustitución de suministros naturales por tecnología para obtener agua.
Paso 2: Personalizar
Este paso permite al usuario personalizar valores para los parámetros de entrada que después se enviarán al modelo.
Figura 04: Pantalla de personalización
Los parámetros de entrada se dividen en las siguientes categorías:
- Sector Urbano: Parámetros de entrada municipales e industriales.
- Sector Agrícola: Parámetros agrícolas - ej. producción de cultivo, precios del cultivo.
- Sostenibilidad: Límites de conservación del suministro de agua natural en referencia al año inicial.
Figura 05: Ejemplo de los parámetros modificables en la página de Personalizar
Los "widgets" de parámetro de entrada pueden presentar en forma de tablas de datos. La siguiente figura muestra los parámetros modificables por el usuario para la categoría de agricultura, la columna en el extremo derecho de cada tabla puede ser modificada directamente.
Figura 06: Ejemplo de los "widgets" de tablas de datos que se encuentran en Personalización
La figura de abajo muestra un ejemplo de un "widget" de entrada en un recuadro. Cada recuadro contiene los siguientes elementos:
- Título del parámetro.
- Descripción del parámetro.
- "Widget" de entrada que permite visualizar y/o modificar los valores del parámetro, pueden presentarse en forma de campos de texto, controles deslizantes o tablas de datos.
- Unidades del valor del parámetro. ej. USD/ton - (Dólares estadounidenses por tonelada).
- Fuente por defecto de la que proviene el valor inicial.
Figura 07: Panorama en primer plano del recuadro "Widget" de entrada que se encuentra en Personalizar
Paso 3: Revisar y ejecutar
El paso de revisión y ejecución puede ser accesado directamente en cualquier momento sin la necesidad de especificar escenarios o parámetros personalizados, lo cual permite al usuario enviar un modelo a ejecución con valores de entrada default.
La pantalla de revisión y ejecución presentada abajo contiene una tabla dinámica que enumera todos parámetros de entrada que maneja la interfaz. La tabla muestra el nombre del parámetro, descripción, límite superior, límite inferior, unidades, fuente y tipo de parámetro. La tabla permite búsqueda y clasificación dinámica según sea necesario.
Figura 08: Pantalla de Revisión y Ejecución
Al hacer clic en una de las filas se muestra información acerca del parámetro seleccionado en un formato más detallado.
Figura 09: Subsección de Detalles en la pantalla de revisión y ejecución que se encuentra en Crear Escenario
El botón verde de "Ejecutar Escenario" hará que aparezca un menú emergente, el cuál capturará los metadatos del escenario antes de ser enviado a ejecución Todos los campos deben ser llenados antes de poder habilitar el botón de enviar.
Si el usuario ha iniciado sesión, se puede especificar si el escenario estará disponible al público o solamente para registros privados.
Figura 10: El menú emergente de Metadatos y Ejecución aparece cuando se presiona el botón de Correr Escenario que se encuentra en la pantalla de Revisión y Ejecución
Paso 4: Resultados
Una vez que la ejecución del modelo ha terminado, la interfaz se redirige automáticamente a la sección de resultados. Esta sección contiene todos los valores de las variables de salida y metadatos generados por la ejecución del modelo.
La sección de Resultados se divide en las siguientes subsecciones:
- Resumen: Valores globales agregados de los resultados generados.
- Sector Urbano: Valores municipales e industriales de salida.
- Sector Agrícola: Variables de salida del uso agrícola.
- Almacenamiento: Niveles anuales de reservas y acuíferos.
- Flujos: Beneficios económicos de los flujos fluviales.
- Mapa: Visualización espacial del área del proyecto, fuentes de agua y medidores.
- JSON: Salida en formato JSON del escenario ejecutado.
La subsección de resumen presenta los datos promedio que fueron generados de la ejecución. Están divididos en dos secciones: Valores Promedio Globales (Figura 10) y Valores Globales Totales (Figura 11).
Figura 11: Algunas de las categorías de salida que se muestran bajo Valores Promedio Globales en la subsección de Resumen en Datos de Salida del Modelo
La sección de Valores Promedio Globales contiene un conjunto de recuadros de salida con valores generados por el modelo e información acerca de cada variable.
Cada recuadro de variables de salida contiene los siguientes elementos:
- Nombre de la variable de salida.
- Descripción de la variable de salida.
- Datos de salida del modelo comparados con datos históricos de 1995 a 2015.
- Unidades de medida de los valores mostrados, ej. 1000 USD/año.
Figura 12: Sección de Valores Promedio Globales en la subsección de Resumen en Datos de Salida del Modelo
Figura 13: Vista en primer plano del recuadro de variables de salida con datos tabulados
Los botones de visualización permiten al usuario cambiar entre diferentes representaciones gráficas para una variable de salida específica. Las visualizaciones de gráficos son procesadas después de presionar el botón de gráfico.
Figura 14: Vista en primer plano del recuadro de variables de salida con gráfico lineal
La vista de datos tabulados permite al usuario filtrar, clasificar o exportar datos a un documento csv.
Las opciones se pueden ver al presionar la esquina superior derecha del "widget" de tabla.
Figura 15: Ejemplo de la función de filtrado de datos en la vista de datos de salida tabulados en el recuadro
La subsección de Mapa abre un Mapa ArcGis del area de estudio del proyecto.
Figura 16: Mapa ArcGis del Área de estudio del proyecto USDA CAP
La subsección de JSON en Datos de Salida del Modelo abre un documento JSON que contiene todos los datos de salida del modelo.
Figure 17: Documento JSON en Datos de Salida del Modelo
Paso 5: Procedencia del Modelo
Este paso genera una visualización de árbol de la logística de procedencia y los metadatos del modelo de agua; esto permite al usuario seguir el flujo de la ejecución y las fuentes de datos del modelo actual.
La estructura de árbol se divide en los siguientes niveles:
- Flujo de trabajo del usuario: Sigue los pasos del flujo del trabajo, define los parámetros y fuentes, ejecuta el modelo y da los datos de salida del modelo.
- Modelo de agua: Da información de los metadatos con respecto al modelo actual como nombre, descripción, creadores, software de modelaje y otros atributos.
Cada nivel se puede expandir al hacer clic en los nodos solidos.
El primer nivel del árbol de procedencia muestra los pasos del flujo de trabajo del usuario los cuales pueden ser expandidos para ver los detalles de cada actividad hecha en ese mismo paso.
Figura 18: Expansión del primer nivel del árbol de procedencia
El seguimiento de parámetros de entrada puede ser visto al expandir los siguientes nodos: Flujo de trabajo del usuario > Paso 3: Personalizacion > Lista de parámetros
Los parámetros de entrada se dividen en categorías que adicionalmente se pueden expandir con el fin de concentrarse en una entrada específica. Cada parámetro de entrada posee un nodo que se puede expandir hasta que muestre información de los metadatos, valores por defecto y valores definidos por el usuario.
Figura 19: Expansión del árbol de metadatos que muestra información de los metadatos, valores por defecto y valores definidos por el usuario
Escenarios Públicos
La sección de escenarios públicos muestra una tabla que enumera todos los escenarios que han sido previamente ejecutados por los usuarios. Cada entrada presenta nombre, valores promedio y opción de ver detalles adicionales. Esta tabla puede ser organizada o filtrada como sea requerido.
Figura 20: Pantalla principal de Escenarios Públicos
Detalles del Escenario
Cada fila de entradas contiene un botón debajo de la columna de detalles. Cuando ese botón es presionado la aplicación carga una ventana emergente con información general sobre la ejecución del modelo (escenario personalizado).
Los resultados pueden ser consultados en formato JSON o pueden ser reasignados en el flujo de trabajo de la interfaz para ser visualizados gráficamente.
Figura 21: Ventana emergente de "Escenario Personalizado" que aparece al hacer clic en la columna de Detalles
Figura 22: Archivo JSON con los resultados del escenario público
Comparación de Escenarios
Los usuarios tienen la opción de comparar hasta dos escenarios. Esto se puede lograr al seleccionar dos filas en la página Escenarios Públicos (las filas seleccionadas son resaltadas en azul) y, después, seleccionar el botón "Comparar".
Figura 23: Parte inferior de la página de Escenarios Públicos con dos escenarios seleccionados
Una vez que se haya seleccionado el botón "Comparar", se abrirá la página de Comparación Cruzada. La página de Comparación Cruzada se divide en tres subsecciones:
Resumen:
Muestra información resumida de los dos escenarios y la comparación de sus resultados.
Figura 24: Información resumida sobre los dos escenarios dentro de la pestaña Resumen en la página de Comparación Cruzada
Figura 25: Comparación resumida de los resultados de ambos escenarios dentro de la pestaña de Resumen en la página de Comparación Cruzada
Valores de Entrada:
Muestra una tabla detallada que compara todas las entradas para los dos escenarios y permite la comparación de entradas específicas.
Figura 26: Tabla de comparación detallada de todas las entradas para ambos escenarios dentro de la pestaña Entradas en la página de Comparación Cruzada
Si el usuario selecciona una fila, será llevado automáticamente a la pestaña de Comparación. Esta página muestra una comparación detallada de las entradas seleccionadas por el usuario.
Figura 27: Tablas de comparación detalladas de la entrada de Capacidad de bombeo agrícola
Valores de Salida:
Muestra una tabla detallada que compara todas las salidas para los dos escenarios y permite la comparación de valores de salida específicos.
Figura 28: Tabla de comparación detallada de todas las salidas para ambos escenarios dentro de la pestaña de Salidas en la página de Comparación Cruzada
Si el usuario selecciona una fila, el usuario será llevado automáticamente a la pestaña Comparación dentro de la pestaña de Salida. Esta página muestra una comparación detallada del valor de salida seleccionado por el usuario.
Figura 29: Tablas comparativas detalladas de la salida de Retorno agrícola del bombeo al acuífero
Si los valores de salida cambian con el tiempo, el usuario puede ver estos cambios en un gráfico de líneas seleccionando el botón "Vista de gráfico".
Figurea 30: Cuadros comparativos detallados de la salida de Retorno agrícola del bombeo al acuífero
El usuario puede moverse entre las tres pestañas haciendo clic en "Siguiente" y "Anterior" o haciendo clic en las pestañas directamente.
Registro de Usuario
Cualquier usuario tiene la opción de registrarse en el sistema. Los usuarios registrados tienen la capacidad de ver por separado sus escenarios personalizados con la opción de hacerlos públicos o no antes de su ejecución.
Para registrarse, el usuario debe activar el menú desplegable de inicio de sesión ubicado en el extremo derecho del menú principal. Hay una opción para iniciar sesión directamente o registrarse en el sistema.
Figura 31: Menú desplegable de inicio de sesión en la barra de navegación
Figura 32: Ventana modal de suscripción que aparece si selecciona Registrarse en el menú desplegable de inicio de sesión
Mis Escenarios
Los usuarios registrados pueden iniciar sesión en el sistema y tener acceso a sus escenarios ejecutados previamente.
Figura 33: Menú desplegable en la barra de navegación
Figura 34: Tabla de datos llena de escenarios de usuario anteriores
Contactos
Luis Antonio Garnica Chavira
Consultor de Ingeniería de Software
Git Gud Consulting SAS
luis@gitgudconsulting.com
Dr. Deana Pennington
Profesor Asociado
Departamento de Ciencias Geológicas
Universidad de Texas en El Paso
ddpennington@utep.edu