diff --git a/docs/manual/README.md b/docs/manual/README.md new file mode 100644 index 0000000..1e51c50 --- /dev/null +++ b/docs/manual/README.md @@ -0,0 +1,153 @@ +--- +layout: default +title: Manual +nav_order: 3 +has_toc: false +title: Manual +parent: QGIS Fire Analytics Toolbox +--- +

Fire Analytics Toolbox

+

0.2.3

+

Fire Management & Advanced Analytics Group

+![](images/logo plugin.png) + +# Introducción +El complemento de QGIS, Fire Analytics Toolbox, es una herramienta informática para la gestión y el análisis de los incendios forestales. Está diseñado para facilitar la simulación de incendios forestales, calcular métricas de riesgo y optimizar la ubicación de tratamiento de combustibles, todo directamente desde QGIS. La interfaz del plugin permite realizar estas tareas de manera intuitiva mediante formularios simples y herramientas de arrastrar y soltar. En este manual se detallan las instrucciones de instalación, configuaraciones iniciales, funciones principales, ejemplos de uso y la solución de problemas que puedan ocurrir durante la utilización de las herramientas. + +Desarrollada por el grupo de investigación [Fire2A](https://www.fire2a.com/) + +# Instalación + +En esta sección se detalla la instalación de QGIS y de la caja de herramientas de Fire Analytics. + +## Instalación de QGIS +A continuación se detalla la instalación de QGIS y los requerimientos de paquetes para los diferentes sistemas operativos. + +### Windows + +Para la instalación en Windows hay dos opciones: +- Instalación desde [enlace](https://qgis.org/en/site/forusers/download.html#windows). Se recomienda la última versión estable. + +Para poder ocupar las funciones del Plugin, también es necesario instalar algunas librerías, esto se hace mediante el ambiente de Python que incluye QGIS. A continuación se detallan los pasos a seguir: +1. Guardar el siguiente archivo [requeriments.txt](https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/fireanalyticstoolbox/requirements.txt) (segundo click y guardar enlace como) +2. Activar el python de QGIS +3. Escribir `!pip install --upgrade fire2a-lib` y presionar ENTER (ajustar ruta para indicar la ubicación del archivo de requerimientos). + +### MacOS +Para la instalación en MacOS, descargar del siguiente [enlace](https://qgis.org/en/site/forusers/download.html#mac). + +Instalar requerimientos: +1. Guardar el siguiente archivo [requeriments.txt](https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/fireanalyticstoolbox/requirements.txt) (segundo click y guardar enlace como). +2. Abrir terminal + +```python +# go to QGIS python location +% cd /Applications/QGIS.app/Contents/MacOS/bin +# install into qgis python environment +% ./python3 -m pip install -r ~/Downloads/requirements.txt +# matplotlib bug: can't find qt_backend +% ./python3 -m pip install --upgrade matplotlib +``` + +### Linux +En Linux hay tres alternativas: +1. Gnome: Super (or Meta) Key > escribir 'QGIS' > Clickear 'Install' en la ventana del software +2. Synaptic: Buscar QGIS, clickear install +3. Terminal: +``` +sudo apt install qgis qgis-plugin-grass +``` + +Instalación de requerimientos: +Descargar [requerimientos.txt](https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/fireanalyticstoolbox/requirements.txt), [requirements.dev.txt](https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/requirements.dev.txt) y Correr la siguiente línea en el terminal: + +```python +-m venv --system-site-packages -r requirements.txt, requirements.dev.txt +``` + +## Instalación del Fire Anlytics Toolbox +1. Añadir [enlace](https://fire2a.github.io/fire-analytics-qgis-processing-toolbox-plugin/plugins.xml) del plugin a la pestaña de fuentes personalizables: +Menú: Plugins > Manage and Install Plugins... > Settings > Plugin Repositories Add > llenar Nombre y pegar URL > Ok + ![Menú de plugins personalizables](images/tldr_add_plugin_source.png) +1. Instalar nuevo plugin: + - Menú: Plugins > Manage and Install Plugins... > Not installed > search box fire > select > Install Plugin > Ok + - Si el plugin no aparece inmediatamente: + A. Marcar la casilla del plugin en la sección de plugins instalados. + B. Reiniciar QGIS + +# Resultados y algoritmos +En esta sección se detallan los resultados que se pueden obtener a partir del algoritmo de simulación, así como de algoritmos auxiliares de decisión y post-procesamiento. + +## Resultados +Al seleccionar los resultados del algoritmo de simulación, se pueden elegir entre varias opciones. A continuación, se describen las alternativas disponibles. + +* Final Fire Scar (Cicatriz final del fuego): Cicatriz final del incendio para cada simulación. El formato es archivos .asc +* Propagation Fire Scars (Cicatrices de propagación del fuego): Cicatriz para cada +paso de tiempo transcurrido del incendio, para cada simulación. Formato archivos .asc +* Propagation Directed Graph (Grafo dirigido de propagación): Grafo que indica la propagación del incendio (de qué pixel a qué pixel pasó el fuego). Formato .csv +* Ignition Points (Puntos de ignición): Los puntos en que empezó el fuego en cada simulación. Formato .csv +* Hit Rate of Spread (Tasa de propagación al impacto): Velocidad de propagación del fuego al momento de alcanzar la pixel quemada. Formato archivos .asc +* Flame Length (Longitud de la llama): La distancia medida desde la punta promedio de la llama hasta la mitad de la zona de combustión en la base del fuego. Formato archivos .asc +* Byram Intensity (Intensidad de Byram): La tasa de liberación de energía (o calor) por unidad de tiempo y por unidad de longitud del frente de fuego. Formato archivos .asc +* Crown Fire Scar (Cicatriz de fuego en la copa) Cicatriz final del fuego de copa para cada simulación. Formato archivos .asc +* Crown Fire Fuel Consumption (Proporción de consumo de combustible en fuego de copa). Formato archivos .asc +* Surface Burn Fraction (Fracción de quema superficial). Formato archivos .asc + +![Despliegue de opciones](images/rya1.png) +![Selección de resultados](images/rya2.png) + +## Algoritmos +### Algortimos de decisión +La caja de herramientas cuenta con una serie de algoritmos, ya sea para apoyar el proceso de toma de decisiones, o para realizar un post procesamiento de las simulaciones. Los resultados de los algoritmos pueden ser obtenidos en diversos formatos (GPKG, TIFF, SHP, etc.) y para visualizarlos se deben arrastrar las capas correspondientes a la pestaña de capas del proyecto de QGIS. + +![Visualización de capas de resultados](images/capas.png) + +* Raster knapsack optimization +* Polygon knapsack optimization : Optimiza el problema clásico de la mochila utilizando polígonos con atributos de valores y/o pesos, y devuelve una capa de polígonos con los polígonos seleccionados. +* Polygon treatment optimization : Usando los posibles tratamientos para cada polígono, maximiza el valor modificado de los polígonos tratados. +* Raster treatment optimization : Maximiza el valor modificado del raster tratado, decidiendo qué tratamiento aplicar a cada píxel (o no realizar cambios), sujeto a restricciones de presupuesto y área. +* Raster treatment \& teams optimization : Maximiza el valor modificado del raster tratado, decidiendo qué tratamiento aplicar y qué equipo asignar a cada píxel (o no realizar cambios), sujeto a restricciones de presupuesto, área y capacidades del equipo. + +### Simulator Post Processing (simpp) + +* Ignition Point(s) (Puntos de Ignición): Entrega los puntos de ignición en formato raster +* (Propagation) Fire Scar(s) (Cicatrices de propagación): A partir de las cicatrices finales se puede obtener la probabilidad de quema (Burn probability) y un raster/polígono de las cicatrices finales. +* Propagation Digraph (Digrafo de propagación) +* Spatial Statistics, cualquiera de: Hit Rate Of Spread, Flame Length, Byram Fire Line Intensity, Crown Fire Scar, Crown Fire Fuel Consumption Ratio, Surface Burn Fraction + +A continuación se presenta la visualización de las capas de probabilidad de quema y puntos de ignición, usando los correspondientes algoritmos y una instancia correspondiente a 1.000 incendios en la zona de Villarica. + +![Instancia de Villarica con puntos de ignición y probabilidad de quema](images/villarica.png) + +### Risk Metrics + +* DownStream Protection Value: Raster con el valor de protección ``aguas abajo`` para cada pixel según capa de valores en riesgo, para más información visitar la documentación. +* Betweenness Centrality: Medida propia de grafos que determina hasta qué punto un vértice se encuentra en los caminos entre otros vértices. +* Burn Probability: Probabilidad de quema de cada pixel calculada como la cantidad de veces que se quemó dicho pixel entre todas las simulaciones realizadas. + +# Ejemplo de Uso +En esta seccion se detalla un ejemplo de uso utilizando una instancia descargada del Instance Donwloader correspondiente a la zona de Villarica. Tambien se muestra la obtencion de distintos resultados y su visualizacion dentro de QGIS. + +Si no se dispone de un raster de modelo de combustible, es posible obtener uno siguiendo los siguientes pasos: + +* Para utilizar las funciones de la caja de herramientas es necesario contar con un set de datos geográficos y meteorológicos. Si ud. no dispone de dichos recursos puede utilizar el algoritmo ``Instance Downloader`` para descargar una instancia preparada. Para este proyecto de prueba descargaremos la zona de Villarica correspondiente al modelo de combustibles de Kitral. + ![Descargador de instancias](images/foto_instancia.png) + ![Cuadro de descarga](images/foto_instancia2.png) + +* Guarde un proyecto vacío en la carpeta descargada (donde están los archivos fuels, elevation y Weather.csv). + ![Guardar proyecto](images/foto_instancia3.png) + +* Arrastre y suelte capas desde el proyecto principal (Panel del Explorador de Archivos) al Panel de Capas. + ![Guardar proyecto](images/capas_2.png) + +* Establezca el mismo CRS (Sistema de Referencia de Coordenadas) para las capas y el proyecto (cualquiera en metros es suficiente para obtener los resultados, sin embargo para una correcta geo-referencia se necesita el sistema de coordenadas adecuado). + ![Sistema de coordenadas proyecto](images/foto_instancia4.png) + ![Sistema de coordenadas capas](images/foto_instancia5.png) + +* Abra el algoritmo del simulador, seleccione el modelo de combustible adecuado (Canada, Kitral o S&B), seleccione la capa de combustible en el menú desplegable de combustible y presione ejecutar. + +# Referencias +Para más información se recomienda visitar la [documentación](https://fire2a.github.io/docs/) + +Contacto del desarrollador: +Matias Vilches diff --git a/docs/manual/images/.gitkeep b/docs/manual/images/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/manual/instalacion.md b/docs/manual/instalacion.md new file mode 100644 index 0000000..27ac41d --- /dev/null +++ b/docs/manual/instalacion.md @@ -0,0 +1,86 @@ +En esta sección se detalla la instalación de QGIS y de la caja de herramientas de Fire Analytics. + +\subsection{Instalación de QGIS} +A continuación se detalla la instalación de QGIS y los requerimientos de paquetes para los diferentes sistemas operativos. + +\subsubsection{Windows} +Para la instalación en Windows hay dos opciones: +\\ \\ Instalación desde \href{https://qgis.org/en/site/forusers/download.html#windows}{\underline{enlace}}. Se recomienda la última versión estable. + +Para poder ocupar las funciones del Plugin, también es necesario instalar algunas librerías, esto se hace mediante el ambiente de Python que incluye QGIS. A continuación se detallan los pasos a seguir: +\begin{enumerate} + \item Guardar el siguiente archivo \href{https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/fireanalyticstoolbox/requirements.txt}{requeriments.txt} (segundo click y guardar enlace como) + \item Activar el python de QGIS + \item Escribir + \begin{listing}[h!] + \begin{minted}{python} + !pip install --upgrade fire2a-lib + \end{minted} + \label{listing:py} + \end{listing} y presionar ENTER (ajustar ruta para indicar la ubicación del archivo de requerimientos). +\end{enumerate} + + +\subsubsection{MacOS} +Para la instalación en MacOS, descargar del siguiente \href{https://qgis.org/en/site/forusers/download.html#mac}{enlace}. + +Instalar requerimientos: +\begin{enumerate} + \item Guardar el siguiente archivo \href{https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/fireanalyticstoolbox/requirements.txt}{requeriments.txt} (segundo click y guardar enlace como). + \item Abrir terminal + +\begin{listing}[h!] +\begin{minted}{python} +# go to QGIS python location +% cd /Applications/QGIS.app/Contents/MacOS/bin +# install into qgis python environment +% ./python3 -m pip install -r ~/Downloads/requirements.txt +# matplotlib bug: can't find qt_backend +% ./python3 -m pip install --upgrade matplotlib +\end{minted} +\label{listing:py} +\end{listing} +\end{enumerate} + +\subsubsection{Linux} +En Linux hay tres alternativas: +\begin{enumerate} + \item Gnome: Super (or Meta) Key > escribir 'QGIS' > Clickear 'Install' en la ventana del software + \item Synaptic: Buscar QGIS, clickear install + \item Terminal: + \begin{listing}[H] + \begin{minted}{python} + sudo apt install qgis qgis-plugin-grass + \end{minted} + \label{listing:py} + \end{listing} +\end{enumerate} + +Instalación de requerimientos: +\\ Descargar \href{https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/fireanalyticstoolbox/requirements.txt}{requerimientos.txt}, \href{https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/requirements.dev.txt}{requirements.dev.txt} y Correr la siguiente línea en el terminal: +\begin{listing}[h!] + \begin{minted}{python} + -m venv --system-site-packages -r requirements.txt, requirements.dev.txt + \end{minted} + \label{listing:py} + \end{listing} + +\subsection{Instalación del Fire Anlytics Toolbox} +\begin{enumerate} + \item Añadir \href{https://fire2a.github.io/fire-analytics-qgis-processing-toolbox-plugin/plugins.xml}{\underline{enlace}} del plugin a la pestaña de fuentes personalizables: + \\ Menú: Plugins > Manage and Install Plugins... > Settings > Plugin Repositories Add > llenar Nombre y pegar URL > Ok + +\begin{figure}[H] +\centering +\includegraphics[width=0.7\textwidth]{images/tldr_add_plugin_source.png} +\caption{\label{fig:frog} Menú de plugins personalizables} +\end{figure} + +\item Instalar nuevo plugin: +\\ Menú: Plugins > Manage and Install Plugins... > Not installed > search box fire > select > Install Plugin > Ok + +\end{enumerate} + +Si el plugin no aparece inmediatamente: +\\ A. Marcar la casilla del plugin en la sección de plugins instalados. +\\ B. Reiniciar QGIS diff --git a/docs/manual/instalacion.txt b/docs/manual/instalacion.txt new file mode 100644 index 0000000..149527b --- /dev/null +++ b/docs/manual/instalacion.txt @@ -0,0 +1,86 @@ +En esta sección se detalla la instalación de QGIS y de la caja de herramientas de Fire Analytics. + +\subsection{Instalación de QGIS} +A continuación se detalla la instalación de QGIS y los requerimientos de paquetes para los diferentes sistemas operativos. + +\subsubsection{Windows} +Para la instalación en Windows hay dos opciones: +\\ \\ Instalación desde \href{https://qgis.org/en/site/forusers/download.html#windows}{\underline{enlace}}. Se recomienda la última versión estable. + +Para poder ocupar las funciones del Plugin, también es necesario instalar algunas librerías, esto se hace mediante el ambiente de Python que incluye QGIS. A continuación se detallan los pasos a seguir: +\begin{enumerate} + \item Guardar el siguiente archivo \href{https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/fireanalyticstoolbox/requirements.txt}{requeriments.txt} (segundo click y guardar enlace como) + \item Activar el python de QGIS + \item Escribir + \begin{listing}[h!] + \begin{minted}{python} + !pip install --upgrade fire2a-lib + \end{minted} + \label{listing:py} + \end{listing} y presionar ENTER (ajustar ruta para indicar la ubicación del archivo de requerimientos). +\end{enumerate} + + +\subsubsection{MacOS} +Para la instalación en MacOS, descargar del siguiente \href{https://qgis.org/en/site/forusers/download.html#mac}{enlace}. + +Instalar requerimientos: +\begin{enumerate} + \item Guardar el siguiente archivo \href{https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/fireanalyticstoolbox/requirements.txt}{requeriments.txt} (segundo click y guardar enlace como). + \item Abrir terminal + +\begin{listing}[h!] +\begin{minted}{python} +# go to QGIS python location +% cd /Applications/QGIS.app/Contents/MacOS/bin +# install into qgis python environment +% ./python3 -m pip install -r ~/Downloads/requirements.txt +# matplotlib bug: can't find qt_backend +% ./python3 -m pip install --upgrade matplotlib +\end{minted} +\label{listing:py} +\end{listing} +\end{enumerate} + +\subsubsection{Linux} +En Linux hay tres alternativas: +\begin{enumerate} + \item Gnome: Super (or Meta) Key > escribir 'QGIS' > Clickear 'Install' en la ventana del software + \item Synaptic: Buscar QGIS, clickear install + \item Terminal: + \begin{listing}[H] + \begin{minted}{python} + sudo apt install qgis qgis-plugin-grass + \end{minted} + \label{listing:py} + \end{listing} +\end{enumerate} + +Instalación de requerimientos: +\\ Descargar \href{https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/fireanalyticstoolbox/requirements.txt}{requerimientos.txt}, \href{https://raw.githubusercontent.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin/main/requirements.dev.txt}{requirements.dev.txt} y Correr la siguiente línea en el terminal: +\begin{listing}[h!] + \begin{minted}{python} + -m venv --system-site-packages -r requirements.txt, requirements.dev.txt + \end{minted} + \label{listing:py} + \end{listing} + +\subsection{Instalación del Fire Anlytics Toolbox} +\begin{enumerate} + \item Añadir \href{https://fire2a.github.io/fire-analytics-qgis-processing-toolbox-plugin/plugins.xml}{\underline{enlace}} del plugin a la pestaña de fuentes personalizables: + \\ Menú: Plugins > Manage and Install Plugins... > Settings > Plugin Repositories Add > llenar Nombre y pegar URL > Ok + +\begin{figure}[H] +\centering +\includegraphics[width=0.7\textwidth]{images/tldr_add_plugin_source.png} +\caption{\label{fig:frog} Menú de plugins personalizables} +\end{figure} + +\item Instalar nuevo plugin: +\\ Menú: Plugins > Manage and Install Plugins... > Not installed > search box fire > select > Install Plugin > Ok + +\end{enumerate} + +Si el plugin no aparece inmediatamente: +\\ A. Marcar la casilla del plugin en la sección de plugins instalados. +\\ B. Reiniciar QGIS \ No newline at end of file diff --git a/docs/manual/main_overleaf.txt b/docs/manual/main_overleaf.txt new file mode 100644 index 0000000..6194b24 --- /dev/null +++ b/docs/manual/main_overleaf.txt @@ -0,0 +1,60 @@ +%% Overleaf +%% Software Manual and Technical Document Template +%% +%% This provides an example of a software manual created in Overleaf. + +\documentclass{ol-softwaremanual} + +% Packages used in this example +\usepackage{graphicx} % for including images +\usepackage{microtype} % for typographical enhancements +\usepackage{minted} % for code listings +\usepackage{amsmath} % for equations and mathematics +\setminted{style=friendly,fontsize=\small} +\renewcommand{\listoflistingscaption}{List of Code Listings} +\usepackage{hyperref} % for hyperlinks +\usepackage[a4paper,top=4.2cm,bottom=4.2cm,left=3.5cm,right=3.5cm]{geometry} % for setting page size and margins +\usepackage[spanish]{babel} + +% Custom macros used in this example document +\newcommand{\doclink}[2]{\href{#1}{#2}\footnote{\url{#1}}} +\newcommand{\cs}[1]{\texttt{\textbackslash #1}} + +% Frontmatter data; appears on title page +\title{Manual de usuario QGIS Fire Analytics Toolbox \\} +\version{0.2.3} +\author{Fire Management \& Advanced Analytics Group} +\softwarelogo{\includegraphics[width=14cm]{images/logo plugin.png}} + +\begin{document} + +\maketitle + +\tableofcontents +\newpage + +\section{Introduction} + +El complemento de QGIS, Fire Analytics Toolbox, es una herramienta informática para la gestión y el análisis de los incendios forestales. Está diseñado para facilitar la simulación de incendios forestales, calcular métricas de riesgo y optimizar la ubicación de tratamiento de combustibles, todo directamente desde QGIS. La interfaz del plugin permite realizar estas tareas de manera intuitiva mediante formularios simples y herramientas de arrastrar y soltar. En este manual se detallan las instrucciones de instalación, configuaraciones iniciales, funciones principales, ejemplos de uso y la solución de problemas que puedan ocurrir durante la utilización de las herramientas. + + +% desarrollada por el grupo de investigación \href{https://www.fire2a.com/}{\underline{Fire2A}} + +\section{Instalación} + +\input{instalacion} + +\section{Resultados y algoritmos} +\input{rya} + +\section{Ejemplo de Uso} +\input{primer-uso} + +\section{Referencias} +Para más información se recomienda visitar la \href{https://fire2a.github.io/docs/}{\emph{documentación}} + + +Contacto del desarrollador: +\\ Fernando Badilla +\\ fernandobadilla@gmail.com +\end{document} \ No newline at end of file diff --git a/docs/manual/primer_uso.md b/docs/manual/primer_uso.md new file mode 100644 index 0000000..68a878d --- /dev/null +++ b/docs/manual/primer_uso.md @@ -0,0 +1,70 @@ +En esta seccion se detalla un ejemplo de uso utilizando una instancia descargada del Instance Donwloader correspondiente a la zona de Villarica. Tambien se muestra la obtencion de distintos resultados y su visualizacion dentro de QGIS. + +Si no se dispone de un raster de modelo de combustible, es posible obtener uno siguiendo los siguientes pasos: + +* Para utilizar las funciones de la caja de herramientas es necesario contar con un set de datos geográficos y meteorológicos. Si ud. no dispone de dichos recursos puede utilizar el algoritmo ``Instance Downloader`` para descargar una instancia preparada. Para este proyecto de prueba descargaremos la zona de Villarica correspondiente al modelo de combustibles de Kitral. +![Descargador de instancias](images/foto_instancia.png) +![Cuadro de descarga](images/foto_instancia2.png) + +* Guarde un proyecto vacío en la carpeta descargada (donde están los archivos fuels, elevation y Weather.csv). +![Guardar proyecto](images/foto_instancia3.png) + +* Arrastre y suelte capas desde el proyecto principal (Panel del Explorador de Archivos) al Panel de Capas. +![Guardar proyecto](images/capas_2.png) + +* Establezca el mismo CRS (Sistema de Referencia de Coordenadas) para las capas y el proyecto (cualquiera en metros es suficiente para obtener los resultados, sin embargo para una correcta geo-referencia se necesita el sistema de coordenadas adecuado). + +![Sistema de coordenadas proyecto](images/foto_instancia4.png) +![Sistema de coordenadas capas](images/foto_instancia5.png) + +* Abra el algoritmo del simulador, seleccione el modelo de combustible adecuado (Canada, Kitral o S&B), seleccione la capa de combustible en el menú desplegable de combustible y presione ejecutar. + + + +\begin{enumerate} + \item Para utilizar las funciones de la caja de herramientas es necesario contar con un set de datos geográficos y meteorológicos. Si ud. no dispone de dichos recursos puede utilizar el algoritmo ``Instance Downloader`` para descargar una instancia preparada. Para este proyecto de prueba descargaremos la zona de Villarica correspondiente al modelo de combustibles de Kitral. + + \begin{figure}[H] + \centering + \includegraphics[width=0.45\textwidth]{images/foto_instancia.png} + \caption{\label{fig:frog} Descargador de instancias} + \end{figure} + + \begin{figure}[H] + \centering + \includegraphics[width=0.5\textwidth]{images/foto_instancia2.png} + \caption{\label{fig:frog} Cuadro de descarga} + \end{figure} + + \item Guarde un proyecto vacío en la carpeta descargada (donde están los archivos fuels, elevation y Weather.csv). + + \begin{figure}[H] + \centering + \includegraphics[width=0.5\textwidth]{images/foto_instancia3.png} + \caption{\label{fig:frog} Guardar proyecto} + \end{figure} + + \item Arrastre y suelte capas desde el proyecto principal (Panel del Explorador de Archivos) al Panel de Capas. + + \begin{figure}[H] + \centering + \includegraphics[width=0.3\textwidth]{images/capas_2.png} + \caption{\label{fig:frog} Guardar proyecto} + \end{figure} + + \item Establezca el mismo CRS (Sistema de Referencia de Coordenadas) para las capas y el proyecto (cualquiera en metros es suficiente para obtener los resultados, sin embargo para una correcta geo-referencia se necesita el sistema de coordenadas adecuado). + + \begin{figure}[H] + \centering + \includegraphics[width=0.7\textwidth]{images/foto_instancia4.png} + \caption{\label{fig:frog} Sistema de coordenadas proyecto} + \end{figure} + + \begin{figure}[H] + \centering + \includegraphics[width=0.7\textwidth]{images/foto_instancia5.png} + \caption{\label{fig:frog} Sistema de coordenadas capas} + \end{figure} + + \item Abra el algoritmo del simulador, seleccione el modelo de combustible adecuado (Canada, Kitral o S\&B), seleccione la capa de combustible en el menú desplegable de combustible y presione ejecutar. +\end{enumerate} diff --git a/docs/manual/primer_uso.txt b/docs/manual/primer_uso.txt new file mode 100644 index 0000000..cb55a80 --- /dev/null +++ b/docs/manual/primer_uso.txt @@ -0,0 +1,51 @@ +En esta seccion se detalla un ejemplo de uso utilizando una instancia descargada del Instance Donwloader correspondiente a la zona de Villarica. Tambien se muestra la obtencion de distintos resultados y su visualizacion dentro de QGIS. + +Si no se dispone de un raster de modelo de combustible, es posible obtener uno siguiendo los siguientes pasos: + +\begin{enumerate} + \item Para utilizar las funciones de la caja de herramientas es necesario contar con un set de datos geográficos y meteorológicos. Si ud. no dispone de dichos recursos puede utilizar el algoritmo ``Instance Downloader`` para descargar una instancia preparada. Para este proyecto de prueba descargaremos la zona de Villarica correspondiente al modelo de combustibles de Kitral. + + \begin{figure}[H] + \centering + \includegraphics[width=0.45\textwidth]{images/foto_instancia.png} + \caption{\label{fig:frog} Descargador de instancias} + \end{figure} + + \begin{figure}[H] + \centering + \includegraphics[width=0.5\textwidth]{images/foto_instancia2.png} + \caption{\label{fig:frog} Cuadro de descarga} + \end{figure} + + \item Guarde un proyecto vacío en la carpeta descargada (donde están los archivos fuels, elevation y Weather.csv). + + \begin{figure}[H] + \centering + \includegraphics[width=0.5\textwidth]{images/foto_instancia3.png} + \caption{\label{fig:frog} Guardar proyecto} + \end{figure} + + \item Arrastre y suelte capas desde el proyecto principal (Panel del Explorador de Archivos) al Panel de Capas. + + \begin{figure}[H] + \centering + \includegraphics[width=0.3\textwidth]{images/capas_2.png} + \caption{\label{fig:frog} Guardar proyecto} + \end{figure} + + \item Establezca el mismo CRS (Sistema de Referencia de Coordenadas) para las capas y el proyecto (cualquiera en metros es suficiente para obtener los resultados, sin embargo para una correcta geo-referencia se necesita el sistema de coordenadas adecuado). + + \begin{figure}[H] + \centering + \includegraphics[width=0.7\textwidth]{images/foto_instancia4.png} + \caption{\label{fig:frog} Sistema de coordenadas proyecto} + \end{figure} + + \begin{figure}[H] + \centering + \includegraphics[width=0.7\textwidth]{images/foto_instancia5.png} + \caption{\label{fig:frog} Sistema de coordenadas capas} + \end{figure} + + \item Abra el algoritmo del simulador, seleccione el modelo de combustible adecuado (Canada, Kitral o S\&B), seleccione la capa de combustible en el menú desplegable de combustible y presione ejecutar. +\end{enumerate} \ No newline at end of file diff --git a/docs/manual/rya.md b/docs/manual/rya.md new file mode 100644 index 0000000..da73f83 --- /dev/null +++ b/docs/manual/rya.md @@ -0,0 +1,50 @@ +En esta sección se detallan los resultados que se pueden obtener a partir del algoritmo de simulación, así como de algoritmos auxiliares de decisión y post-procesamiento. + +# Resultados +Al seleccionar los resultados del algoritmo de simulación, se pueden elegir entre varias opciones. A continuación, se describen las alternativas disponibles. + +* Final Fire Scar (Cicatriz final del fuego): Cicatriz final del incendio para cada simulación. El formato es archivos .asc +* Propagation Fire Scars (Cicatrices de propagación del fuego): Cicatriz para cada +paso de tiempo transcurrido del incendio, para cada simulación. Formato archivos .asc +* Propagation Directed Graph (Grafo dirigido de propagación): Grafo que indica la propagación del incendio (de qué pixel a qué pixel pasó el fuego). Formato .csv +* Ignition Points (Puntos de ignición): Los puntos en que empezó el fuego en cada simulación. Formato .csv +* Hit Rate of Spread (Tasa de propagación al impacto): Velocidad de propagación del fuego al momento de alcanzar la pixel quemada. Formato archivos .asc +* Flame Length (Longitud de la llama): La distancia medida desde la punta promedio de la llama hasta la mitad de la zona de combustión en la base del fuego. Formato archivos .asc +* Byram Intensity (Intensidad de Byram): La tasa de liberación de energía (o calor) por unidad de tiempo y por unidad de longitud del frente de fuego. Formato archivos .asc +* Crown Fire Scar (Cicatriz de fuego en la copa) Cicatriz final del fuego de copa para cada simulación. Formato archivos .asc +* Crown Fire Fuel Consumption (Proporción de consumo de combustible en fuego de copa). Formato archivos .asc +* Surface Burn Fraction (Fracción de quema superficial). Formato archivos .asc + +![Despliegue de opciones](images/rya1.png) + +![Selección de resultados](images/rya2.png) + +# Algoritmos +## Algortimos de decisión +La caja de herramientas cuenta con una serie de algoritmos, ya sea para apoyar el proceso de toma de decisiones, o para realizar un post procesamiento de las simulaciones. Los resultados de los algoritmos pueden ser obtenidos en diversos formatos (GPKG, TIFF, SHP, etc.) y para visualizarlos se deben arrastrar las capas correspondientes a la pestaña de capas del proyecto de QGIS. + +![Visualización de capas de resultados](images/capas.png) + +* Raster knapsack optimization +* Polygon knapsack optimization : Optimiza el problema clásico de la mochila utilizando polígonos con atributos de valores y/o pesos, y devuelve una capa de polígonos con los polígonos seleccionados. +* Polygon treatment optimization : Usando los posibles tratamientos para cada polígono, maximiza el valor modificado de los polígonos tratados. +* Raster treatment optimization : Maximiza el valor modificado del raster tratado, decidiendo qué tratamiento aplicar a cada píxel (o no realizar cambios), sujeto a restricciones de presupuesto y área. +* Raster treatment \& teams optimization : Maximiza el valor modificado del raster tratado, decidiendo qué tratamiento aplicar y qué equipo asignar a cada píxel (o no realizar cambios), sujeto a restricciones de presupuesto, área y capacidades del equipo. + +## Simulator Post Processing (simpp) + +* Ignition Point(s) (Puntos de Ignición): Entrega los puntos de ignición en formato raster +* (Propagation) Fire Scar(s) (Cicatrices de propagación): A partir de las cicatrices finales se puede obtener la probabilidad de quema (Burn probability) y un raster/polígono de las cicatrices finales. +* Propagation Digraph (Digrafo de propagación) +* Spatial Statistics, cualquiera de: Hit Rate Of Spread, Flame Length, Byram Fire Line Intensity, Crown Fire Scar, Crown Fire Fuel Consumption Ratio, Surface Burn Fraction + +A continuación se presenta la visualización de las capas de probabilidad de quema y puntos de ignición, usando los correspondientes algoritmos y una instancia correspondiente a 1.000 incendios en la zona de Villarica. + +![Instancia de Villarica con puntos de ignición y probabilidad de quema](images/villarica.png) + +## simpp Risk Metrics + +* DownStream Protection Value: Raster con el valor de protección ``aguas abajo`` para cada pixel según capa de valores en riesgo, para más información visitar la documentación. +* Betweenness Centrality: Medida propia de grafos que determina hasta qué punto un vértice se encuentra en los caminos entre otros vértices. +* Burn Probability: Probabilidad de quema de cada pixel calculada como la cantidad de veces que se quemó dicho pixel entre todas las simulaciones realizadas. + diff --git a/docs/manual/rya.txt b/docs/manual/rya.txt new file mode 100644 index 0000000..147fb91 --- /dev/null +++ b/docs/manual/rya.txt @@ -0,0 +1,71 @@ +En esta sección se detallan los resultados que se pueden obtener a partir del algoritmo de simulación, así como de algoritmos auxiliares de decisión y post-procesamiento. + +\subsection{Resultados} +Al seleccionar los resultados del algoritmo de simulación, se pueden elegir entre varias opciones. A continuación, se describen las alternativas disponibles. + +\begin{itemize} + \item Final Fire Scar (Cicatriz final del fuego): Cicatriz final del incendio para cada simulación. El formato es archivos .asc + \item Propagation Fire Scars (Cicatrices de propagación del fuego): Cicatriz para cada paso de tiempo transcurrido del incendio, para cada simulación. Formato archivos .asc + \item Propagation Directed Graph (Grafo dirigido de propagación): Grafo que indica la propagación del incendio (de qué pixel a qué pixel pasó el fuego). Formato .csv + \item Ignition Points (Puntos de ignición): Los puntos en que empezó el fuego en cada simulación. Formato .csv + \item Hit Rate of Spread (Tasa de propagación al impacto): Velocidad de propagación del fuego al momento de alcanzar la pixel quemada. Formato archivos .asc + \item Flame Length (Longitud de la llama): La distancia medida desde la punta promedio de la llama hasta la mitad de la zona de combustión en la base del fuego. Formato archivos .asc + \item Byram Intensity (Intensidad de Byram): La tasa de liberación de energía (o calor) por unidad de tiempo y por unidad de longitud del frente de fuego. Formato archivos .asc + \item Crown Fire Scar (Cicatriz de fuego en la copa) Cicatriz final del fuego de copa para cada simulación. Formato archivos .asc + \item Crown Fire Fuel Consumption (Proporción de consumo de combustible en fuego de copa). Formato archivos .asc + \item Surface Burn Fraction (Fracción de quema superficial). Formato archivos .asc +\end{itemize} + +\begin{figure}[H] + \centering + \includegraphics[width=0.5\textwidth]{images/rya1.png} + \caption{\label{fig:frog} Despliegue de opciones} + \end{figure} + +\begin{figure}[H] + \centering + \includegraphics[width=0.5\textwidth]{images/rya2.png} + \caption{\label{fig:frog} Selección de resultados} + \end{figure} + +\subsection{Algoritmos} + +\subsubsection{Algortimos de decisión} +La caja de herramientas cuenta con una serie de algoritmos, ya sea para apoyar el proceso de toma de decisiones, o para realizar un post procesamiento de las simulaciones. Los resultados de los algoritmos pueden ser obtenidos en diversos formatos (GPKG, TIFF, SHP, etc.) y para visualizarlos se deben arrastrar las capas correspondientes a la pestaña de capas del proyecto de QGIS. + +\begin{figure}[H] + \centering + \includegraphics[width=0.3\textwidth]{images/capas.png} + \caption{\label{fig:frog} Visualización de capas de resultados} + \end{figure} + +\begin{itemize} +\item Raster knapsack optimization +\item Polygon knapsack optimization : Optimiza el problema clásico de la mochila utilizando polígonos con atributos de valores y/o pesos, y devuelve una capa de polígonos con los polígonos seleccionados. +\item Polygon treatment optimization : Usando los posibles tratamientos para cada polígono, maximiza el valor modificado de los polígonos tratados. +\item Raster treatment optimization : Maximiza el valor modificado del raster tratado, decidiendo qué tratamiento aplicar a cada píxel (o no realizar cambios), sujeto a restricciones de presupuesto y área. +\item Raster treatment \& teams optimization : Maximiza el valor modificado del raster tratado, decidiendo qué tratamiento aplicar y qué equipo asignar a cada píxel (o no realizar cambios), sujeto a restricciones de presupuesto, área y capacidades del equipo. +\end{itemize} + +\subsubsection{Simulator Post Processing (simpp)} +\begin{itemize} + \item Ignition Point(s) (Puntos de Ignición): Entrega los puntos de ignición en formato raster + \item (Propagation) Fire Scar(s) (Cicatrices de propagación): A partir de las cicatrices finales se puede obtener la probabilidad de quema (Burn probability) y un raster/polígono de las cicatrices finales. + \item Propagation Digraph (Digrafo de propagación) + \item Spatial Statistics, cualquiera de: Hit Rate Of Spread, Flame Length, Byram Fire Line Intensity, Crown Fire Scar, Crown Fire Fuel Consumption Ratio, Surface Burn Fraction +\end{itemize} + +A continuación se presenta la visualización de las capas de probabilidad de quema y puntos de ignición, usando los correspondientes algoritmos y una instancia correspondiente a 1.000 incendios en la zona de Villarica. + +\begin{figure}[H] + \centering + \includegraphics[width=0.8\textwidth]{images/villarica.png} + \caption{\label{fig:frog} Instancia de Villarica con puntos de ignición y probabilidad de quema} + \end{figure} + +\subsubsection{simpp Risk Metrics} +\begin{itemize} + \item DownStream Protection Value: Raster con el valor de protección ``aguas abajo`` para cada pixel según capa de valores en riesgo, para más información visitar la documentación. + \item Betweenness Centrality: Medida propia de grafos que determina hasta qué punto un vértice se encuentra en los caminos entre otros vértices. + \item Burn Probability: Probabilidad de quema de cada pixel calculada como la cantidad de veces que se quemó dicho pixel entre todas las simulaciones realizadas. +\end{itemize} \ No newline at end of file diff --git a/docs/manual/uso.md b/docs/manual/uso.md new file mode 100644 index 0000000..fc55ed8 --- /dev/null +++ b/docs/manual/uso.md @@ -0,0 +1,7 @@ +En esta seccion se detalla un ejemplo de uso utilizando una instancia descargada del Instance Donwloader correspondiente a la zona de Villarica. Tambien se muestra la obtencion de distintos resultados y su visualizacion dentro de QGIS. + +* Descargar la instancia usando Instance Downloader. Durante todo el proceso se escogió el área de Villarica, correspondiente al modelo de combustibles de Kitral. A continuación se dejan imágenes para seguir el proceso paso a paso. +* Correr el algoritmo Cell2Fire simulator +* Algoritmos de post procesamiento +* Algoritmos de decisión + diff --git a/docs/manual/uso.txt b/docs/manual/uso.txt new file mode 100644 index 0000000..5c8bd1c --- /dev/null +++ b/docs/manual/uso.txt @@ -0,0 +1,9 @@ +En esta seccion se detalla un ejemplo de uso utilizando una instancia descargada del Instance Donwloader correspondiente a la zona de Villarica. Tambien se muestra la obtencion de distintos resultados y su visualizacion dentro de QGIS. + +\begin{enumerate} + \item Descargar la instancia usando Instance Downloader. Durante todo el proceso se escogió el área de Villarica, correspondiente al modelo de combustibles de Kitral. A continuación se dejan imágenes para seguir el proceso paso a paso. + + \item Correr el algoritmo Cell2Fire simulator + \item Algoritmos de post procesamiento + \item Algoritmos de decisión +\end{enumerate} \ No newline at end of file