Warning

Documentation website under active development. This is not a stable release.

API#

This page provides the complete API reference for the plans python library. Here you will find a list of all available modules, classes, and functions, organized for easy navigation. Each item is documented with its purpose, arguments, return values, and usage details to support effective integration and development.

User Guide

Check out the User Guide for more information about using plans.

Modules#

{Short package description (1-3 sentences)} todo docstring

This module provides a set of the primitive classes used.

plans.analyst

Classes designed to handle statistical analysis.

Standalone geoprocessing routines with minimal dependencies.

plans.project

Project-related classes and routines

plans.hydrology

{Short package description (1-3 sentences)} todo docstring

plans.hydrology.core

{Short module description (1-3 sentences)} todo docstring

plans.hydrology.upscaled

{Short module description (1-3 sentences)} todo docstring

plans.hydrology.downscaled

{Short module description (1-3 sentences)} todo docstring

plans.datasets

{Short package description (1-3 sentences)} todo docstring

plans.datasets.core

Primitive classes for handling datasets.

plans.datasets.chrono

Handle chronological (time series) datasets.

plans.datasets.spatial

Handle spatial datasets (maps).

plans.parsers

{Short package description (1-3 sentences)} todo docstring

plans.parsers.flare

Routines for handling file name formatting

plans.parsers.inmet

Parse data from INMET files (Brazillian Meteorological Office)

plans.parsers.snirh

Parse data from SNIRH Hidroweb files (Brazillian offical hydrological database)

Utility routines for QGIS 3.x Python console

Functions designed to handle plots.