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#
Hydrology and environmental planning tools for Python. |
A set of primitive classes used in other modules. |
Classes for statistical analysis of environmental and hydrological data. |
Standalone geoprocessing routines with minimal dependencies. |
Classes and routines for managing PLANS projects on disk. |
SQLite-based database classes for storing and managing hydro-environmental time series. |
Hydrological modelling subpackage with core, upscaled, and downscaled model classes. |
Base hydrological model class and shared simulation utility functions. |
Design storm distributions and synthetic hydrograph generation (NRCS/SCS method). |
Lumped (upscaled) rainfall-runoff model at watershed scale. |
Spatially distributed (downscaled) rainfall-runoff model. |
Dataset subpackage providing primitives, time series, and spatial map classes. |
Primitive classes for handling datasets. |
Classes for handling chronological (time series) datasets. |
Classes for handling spatial datasets (maps). |
Command-line analysis tools subpackage. |
Base pipeline class, argument parser, and spatial parameter helpers shared by all PLANS tools. |
|
Parsers subpackage for reading external hydrological and meteorological data sources. |
Routines for file name formatting and parsing. |
Parser for INMET files (Brazilian Meteorological Office). |
Parser for SNIRH Hidroweb files (Brazilian national hydrological database). |
Utility routines for QGIS 3.x Python Scripting Tool |
Handle plots in |