Estimating pDRM effects
=======================

.. important::

    This documentation was generated on |today|.
    :code:`pdrm` is still under heavy development and interfaces may change without notice until version 1.0.0 is released.


Publications
============

If you use :code:`pdrm`, please cite the corresponding paper

.. admonition:: 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 :code:`pdrm` in a virtual conda environment.

.. important::

  :code:`pdrm` depends on `paleokalmag <https://sec23.git-pages.gfz-potsdam.de/korte/paleokalmag>`_. You have to install it, before installing :code:`pdrm`.

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

1. Install this theme:

   .. code-block:: bash 

        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

   .. code-block:: bash 

        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

:code:`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.

:code:`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/>.
   

.. |doi-shield| image:: https://img.shields.io/badge/DOI-10.1029%2F2021JB02316-blue.svg
		      :target: https://doi.org/10.1029/2023JB027373



.. toctree::
    :caption: Introduction
    :maxdepth: 2
    :hidden:

    introduction

.. toctree::
    :caption: Estimating pDRM effects
    :maxdepth: 2
    :hidden:

    1_Estimating_pDRM_effects/src/synthetic_tests
    2_data_based_investigation/src/preprocessing/preprocessing
    2_data_based_investigation/src/results

.. toctree::
    :caption: Source
    :titlesonly:
    :maxdepth: 2
    :hidden:

    Repository <https://git.gfz-potsdam.de/sec23/korte/pdrm/>