Estimating pDRM effects

Important

This documentation was generated on Jan 29, 2024. pdrm is still under heavy development and interfaces may change without notice until version 1.0.0 is released.

Publications

If you use pdrm, please cite the corresponding paper

Citation

Bohsung, L.; Schanner, M. A.; Korte, M.; Holschneider, M. (2023)
Estimating post-Depositional Detrital Remanent Magnetization (pDRM) Effects:
A Flexible Lock-In Function Approach
JGR Solid Earth (128)
e2023JB027373

doi-shield

Installation

Note

It is recommended to install pdrm in a virtual conda environment.

Important

pdrm depends on paleokalmag. You have to install it, before installing pdrm.

pdrm is NOT distributed via the PyPI registry. For the installation follow the steps below

  1. Install this theme:

    git clone git@git.gfz-potsdam.de:sec23/korte/pdrm.git

  2. Navigate in the root folder of the cloned repository.

  3. Run the following code

    pip install .

License

GNU General Public License, Version 3, 29 June 2007

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

pdrm 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.

pdrm 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/>.