REHEATFUNQ: A Python package for the inference of regional aggregate heat flow distributions and heat flow anomalies

DOI

The REHEATFUNQ Python package helps to work with the (residual) scatter of surface heat flow even in small regions. REHEATFUNQ uses a stochastic model for regional aggregate heat flow distributions (RAHFD), that is, the collected set of heat flow measurements within a region marginalized to the heat flow dimension. The stochastic model is used in a Bayesian analysis that

(1) yields a posterior estimate of the RAHFD which captures the range of heat flow within the analysis region, and

(2) quantifies the magnitude of a surface heat flow anomaly within the region, for instance through the generating frictional power.

The stochastic model underlying REHEATFUNQ views heat flow data, uniformly sampled across the region of interest, as a random variable. A gamma distribution is used as a model for this random variable and information from the global data set of Lucazeau (2019) is introduced by means of a conjugate prior (Miller, 1980). The detailed science behind the model is described in Ziebarth et al. (202X).

The analysis by Ziebarth et al. (202X) can be reproduced through the Jupyter notebooks contained in the subdirectory “jupyter/REHEATFUNQ/”. The location specified in the map below covers the region to which REHEAFUNQ is applied in this analysis.

REHEATFUNQ is a Python package that uses a compiled Cython/C++ backend. Compiling REHEATFUNQ requires the Meson build system and a number of scientific libraries and Python packages (and their dependencies) that are listed in the documentation.

A Docker image “reheatfunq” is provided as an alternative means of installation. The Docker image comes in two flavors, specified in “Dockerfile” and “Dockerfile-stable”. The former is based on the current “python:slim” image and downloads further dependencies through the Debian package manager, leading to a short image generation time. The latter bootstraps the REHEATFUNQ dependencies from source, aiming to create a reproducible model. To do so, “Dockerfile-stable” depends on the sources contained in “vendor-1.3.3.tar.xz”. If you plan to build the stable image, download both “REHEATFUNQ-1.3.3.tar.gz” and “vendor-1.3.3.tar.xz”, and see the README contained in the latter. Later versions of the “REHEATFUNQ” archive are compatible with the latest “vendor” archive.

A quickstart introduction and the API documentation can be found in the linked documentation.

GNU General Public License, Version 3, 29 June 2007

Copyright © 2021-2022 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany
2022 Malte J. Ziebarth (contributions after June, 2022)

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

Identifier
DOI https://doi.org/10.5880/GFZ.2.6.2023.002
Related Identifier https://mjziebarth.github.io/REHEATFUNQ/
Related Identifier https://doi.org/10.1029/2019gc008389
Related Identifier https://github.com/mjziebarth/REHEATFUNQ/
Related Identifier https://doi.org/10.5194/egusphere-2023-222
Metadata Access http://doidb.wdc-terra.org/oaip/oai?verb=GetRecord&metadataPrefix=oai_datacite&identifier=oai:doidb.wdc-terra.org:7755
Provenance
Creator Ziebarth, Malte Jörn ORCID logo
Publisher GFZ Data Services
Contributor Ziebarth, Malte Jörn
Publication Year 2023
Funding Reference Helmholtz-Gemeinschaft
Rights GNU General Public License, Version 3, 29 June 2007 Copyright © 2021-2022 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany; 2022 Malte J. Ziebarth (contributions after June, 2022); https://www.gnu.org/licenses/gpl-3.0.en.html
OpenAccess true
Contact Ziebarth, Malte Jörn (GFZ German Research Centre for Geosciences, Potsdam, Germany)
Representation
Resource Type Software
Discipline Geosciences
Spatial Coverage (-126.518W, 32.640S, -115.751E, 41.493N); Study region for Ziebarth et al. (2023) for which Jupyter notebooks are available in the REHEATFUNQ archive