Usage

Quick Overview

Installation

To run the plans tool in a virtual or local machine you must clone the latest version of this repository in your system. Also, you must install Python and a few and well-known dependencies:

numpy.
scipy.
matplotlib.
pandas.

The source code of the tool lives in the ./plans-version/plans directory, so it actually works as a Python package. If you are in the ./plans-version level, you can use Python to import the tool and start writing scripts with the modules:

import plans

This also allows you to easily integrate the tool with other useful Python libraries for pre and post processing needs.

Input datasets

Inputs (and also outputs) datasets must be simple plain text files such as .txt for csv tables and .asc for raster maps. Therefore, you may use some third-party applications like Notepad ++ and QGIS for pre-processing your data to fit your data to the standards of plans.

Typical workflow

Typically, to run plans you will go into the following steps (with some iteration):

Gather observed and scenario datasets for your Area Of Interest (AOI).
Pre-process the data so it fits into the standards of the tool.
Use the tool to create a Project for your AOI
Load the datasets to the Project.
Use the tool to assess the datasets.
Use the tool to calibrate the simulation models.
Use the tool to simulate scenarios.
Integrate with extra tools and application for more visualization and data analysis.