Package Documentation

paleokalmag Package

paleokalmag is a python package for Kalman-filter based modeling of the archeo- and paleomagnic field.

Functions

dlib_opt(func, bounds[, args, max_feval, ...])	Find the global minimum of a function, by wrapping dlib's LIPO-TR [dlib], [King] function maximization algorithm in a style similar to scipy.optimize functions.
loadCoreFieldModel(fname[, legacy])	Load a saved instance of CoreFieldModel.
marglog(pars, data[, lmax, R, grad, mean, ...])	Calculates the log forward marginal likelihood.
read_data(fname[, rejection_lists, update_mex])	Read a file produced by the GEOMAGIA database and return a pandas.Dataframe

Classes

Kalman()	A (somewhat) abstract Kalman-filter class, that can be used as a boilerplate.
PaleoKalmag(fname[, name, legacy])	A pymagglobal model that represents the sequentialized models resuling from the paleokalmag algorithm.
CoreFieldModel(lmax, R, gamma, alpha_dip, ...)	A Kalman-filter based model for the paleomagnetic core field.
Data(fname[, drop_duplicates, rejection_lists])	A class that represents paleomagnetic data.
ChunkedData(fname, delta_t[, start, end, ...])	Represents data in chunks.
MapLocPicker(datasets[, models, R, n])	A class to analyze data distributions and models locally.

paleokalmag.utils Module

Utility functions for paleokalmag.

Functions

dsh_basis(lmax, z[, R])	Evaluate the magnetic field basis functions (derivatives of spherical harmonics).
scaling(r_from, r_to, lmax)	Calculate the scaling matrix for Gauss-coefficients