Kalman-filter based paleomagnetic modeling

xkcd like figure showing the dipole moment over the holocene

paleokalmag is a python package for Kalman-filter based modeling of the paleomagnic field. It can be seen as the paleomagnetic extension of the KalMag-model.

The typical workflow consists of three steps:

  1. Set up the data

  2. Set up the model

  3. Run the model

All steps are demonstrated in notebooks here. If you want to dive deeper, have a look at the package documentation.

If you use paleokalmag, please cite the corresponding paper

Citation

Schanner, M. A.; Korte, M.; Holschneider, M. (2021)
ArchKalMag14k: A Kalman-filter based
global geomagnetic model for the Holocene
Earth and Space Science Open Archive

doi-shield

Note

paleokalmag is still under heavy development and interfaces may change without notice until version 0.1.0 is released.

Installation

Note

paleokalmag depends on pymagglobal. You have to install it, before running the install command.

paleokalmag is distributed via the PyPI registry of the corresponding repository. It can be installed using

$ pip3 install paleokalmag --extra-index-url https://public:2kNQxC-mxfHj4qfMJL6z@git.gfz-potsdam.de/api/v4/projects/1793/packages/pypi/simple

paleokalmag further depends on pybind11. Depending on your build system, you may have to install cmake, before you can run the pip3 install ... command.

License

GNU General Public License, Version 3, 29 June 2007

Copyright (C) 2021 Helmholtz Centre Potsdam GFZ, German Research Centre for Geosciences, Potsdam, Germany

paleokalmag is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

paleokalmag is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

Indices and tables