API documentation

This reference manual provides detailed information about the functions, modules, and objects included in pyobsmod. It describes their purpose, functionality, and how they can be used.

pyobsmod

Dataset	Dataset object.
load_dataset	Load Dataset from a pickled dataframe.

pyobsmod.Dataset

Utility methods for quick reading and writing of data

Dataset.save

Save this class as a pickle file.

The methods encapsulated within a Dataset object facilitate the computation of statistical data.

Dataset.bias	Bias.
Dataset.lr	Perform linear regression (y=ax+b).
Dataset.nrmse	Normalize root mean squared error.
Dataset.r	Correlation coefficient.
Dataset.r2	Coefficient of determination.
Dataset.compute_stats	Compute a list of statistics parameters.
Dataset.describe_dataset	Compute the bias, rmse, nrmse, and r2.

The methods encapsulated within a Dataset object facilitate the visualization of the data.

Dataset.scatter_plot	Scatter plot of observed data against modelled data.
Dataset.scatter_plot_joint	Scatter plot sns observed data against modelled data.
Dataset.scatter_plot_sns	Scatter plot sns observed data against modelled data.
Dataset.stats_plot	Textbox plot summarizing specified statistics.
Dataset.time_series_plot	Time series plot of observed data against modelled data.

pyobsmod.plots

Functions that facilitate the visualization of scatter data.

plots.scatter_plot	Scatter plot of observed data against modelled data.
plots.scatter_plot_joint	Scatter plot sns observed data against modelled data.
plots.scatter_plot_sns	Scatter plot sns of observed data against modelled data.
plots.time_series_plot	Time series plot of observed data against modelled data.