Code library

Community Code Repository for Heat Flow and Thermal Parameter Analysis

Open-Source Tools for Advancing Geothermal and Heat Flow Research

The Global Heat Flow Data Research Infrastructure is committed to supporting open science by providing a platform for community-driven code development. This repository hosts open-source scripts, software tools, and computational workflows designed to enhance the analysis, visualization, and interpretation of heat flow and thermal parameter datasets. Our goal is to foster collaboration between researchers, developers, and industry professionals, enabling the exchange of proofed solutions for data handling and analysis for heat flow, temperature and property data.

1. Data Submission: Processing and Quality Control

Heat Flow Data Upload Template for upload (will be published with DOI via GFZ Data Services) - MS Excel (*.xlsx) | version date: 12/2024
An Excel template for the upload of heat flow data according to the structure definition of the Global Heat Flow Database of the IHFC (definition paper).
Heat Flow Data Processing Tool (GitHub) - python | version: XYZ (date: 07/2024)
A Python code that allows checking datasets according to the data, metadata and vocabulary definition of the IHFC. (definition paper).
Heat Flow Quality Assessment Tool (GitHub) - python | version date: 10/2024
A Python code that allows computing the quality code of heat flow data (quality definition). The data needs to be structured according to the template and the metadata definition. Best to use the template and the cleaning tool at first.

2. Special codes for data treatment: Heat flow | subsurface temperatures | conductivities

Heat Flow correction for topography (GitHub) - python |
A Python code that corrects 1D heat flow calculations considering the effect of topography. Code planned for Q4/2025.
Heat Flow correction for erosion (GitHub) - python |
A Python code that corrects 1D heat flow calculations considering the effect of erosion. Code planned for Q4/2025.
Heat Flow correction for sedimentation (GitHub) - python |
A Python code that corrects 1D heat flow calculations considering the effect of rapid sedimentation on heat flow values. Code planned for Q4/2025.
Heat Flow correction for paleoclimate (GitHub) - python |
A Python code that corrects 1D heat flow calculations considering the effect of rapid sedimentation on heat flow values. Code planned for Q4/2025.

How to Contribute

We invite researchers, developers, and data scientists to contribute to this open-source repository! You can:

Submit your code for data processing, modeling, or visualization.
Improve existing scripts by adding features or fixing bugs.
Share documentation and tutorials to help others use the tools effectively.

To contribute, please follow these steps:

Fork our GitHub repository and upload your code.
Submit a pull request with a brief description of your tool and how it works.
Our expert review team will validate your contribution and include it in the code collection on this portal.
You are encouraged to publish your code with DOI (via GFZ Data Services or the direct GitHub-Zenodo link) after it was validated by the curators.

License and Usage

All software and scripts in this repository are released under open-source licenses (e.g., Apache, MIT, GPL), ensuring free use, modification, and redistribution. Please review the license details in each repository before using the code.

Disclaimer

The Global Heat Flow Data Research Infrastructure, the GFZ, and IHFC do not guarantee the accuracy or performance of primary or third-party code contributions. Users should verify the suitability of tools for their specific applications.

Stay Connected & Get Support

Join the Discussion: Have questions or suggestions? Connect with contributors in our Community Portal.

Need help? Reach out to our technical support team at support@heatflow.world.

Follow Updates: Stay informed about new tools and updates by following our GitHub organization.

Comment to reviewers: during phase two of the project, we will enhance the number of codes and actively contribute our own code solutions but also motivate the global partners to do so. Code developers are encouraged to include their codes to the IHFC Code repository and publish them codes with DOIs.