API Reference

This section contains the Documentation of the Application Programming Interface (API) of Pastas. The information in this section is automatically created from the documentation strings in original Python code. In the left-hand menu you will find the different categories of the API documentation.

Submodules

check	This module provides functions for checking and validating Pastas models and their
dataset	This module contains functions to load datasets from the pastas-data repository on
decorators	This module contains decorators and utility functions for Pastas models.
extensions	Extensions subpackage for registering additional functionality to Pastas models.
forecast	This module contains methods to generate forecasts using a Pastas model instance.
io	I/O subpackage for saving and loading Pastas models.
model	This module contains the Model class.
modelstats	The following methods may be used to describe the fit between the model simulation
noisemodels	Noise models may be used to transform the residual series into a noise series that
objective_functions	This module contains the objective functions that can be used with the pastas
plotting	The plotting sub-package contains plot methods and tools for Pastas.
rcparams	This module contains the default configuration parameters for Pastas time series.
recharge	This module contains the classes for recharge models.
rfunc	This module contains all the response functions available in Pastas.
solver	This module contains the different solvers that are available for Pastas.
stats	The stats sub-package contains statistical methods for Pastas.
stressmodels	This module contains all the stress models available in Pastas.
timer	This module contains a timer for model optimization.
timeseries	TimeSeries class for handling time series in Pastas.
timeseries_utils	Utility functions for working with time series.
transform	Nonlinear transforms for time series models.
typing	Typing subpackage for type hints and aliases used throughout Pastas.
utils	This module contains utility functions for working with Pastas models.
version	Module to get and show the current version of Pastas and its dependencies.