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	Functions for checking Pastas models and their components.
dataset	Functions to load datasets from the pastas-data repository on GitHub.
decorators	Module containing decorators and utility functions for Pastas models.
EmceeSolve(*args, **kwargs)	Use ps.solver.Emcee instead (deprecated).
extensions	Extensions subpackage for registering additional functionality to Pastas models.
forecast	Methods to generate forecasts using a Pastas model instance.
io	I/O subpackage for saving and loading Pastas models.
LeastSquares(*args, **kwargs)	Use ps.solver.LeastSquares instead (deprecated).
LmfitSolve(*args, **kwargs)	Use ps.solver.Lmfit instead (deprecated).
model	Module contains the Model class.
modelstats	The following methods may be used to describe the fit between the model simulation and the observations.
noisemodels	Module for noise models.
plotting	The plotting sub-package contains plot methods and tools for Pastas.
rcparams	Module containing the default configuration parameters for Pastas time series.
recharge	Module containing the classes for recharge models.
rfunc	Module containing all the response functions available in Pastas.
solver	solver sub-package contains the solvers and options for parameter (uncertainty) estimation for Pastas.
stats	Stats sub-package contains statistical methods for Pastas.
stressmodels	Module that contains all the stressmodels available in Pastas.
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	Utility functions for working with Pastas models.
version	Module to get and show the current version of Pastas and its dependencies.