Skip to content

Latest commit

 

History

History
58 lines (43 loc) · 2 KB

index.rst

File metadata and controls

58 lines (43 loc) · 2 KB

Welcome to GHEtool's documentation!

Dear visitor

Welcome on this ReadTheDocs for the open-source borefield sizing tool GHEtool.

Here one can find (extensive) documentation of GHEtool codebase. Please find below the content of this ReadTheDocs.

Graphical user interface

There are two graphical user interfaces available which are built using GHEtool: GHEtool Pro and GHEtool Community

GHEtool Pro

GHEtool Pro is the official and supported version of GHEtool which supports drilling companies, engineering firms, architects, government organizations in their geothermal design process. With GHEtool Pro they can minimize the environmental and societal impact while maximizing the cost-effective utilization of geothermal projects. Visit our website at https://ghetool.eu to learn more about the synergy between this open-source package and GHEtool Pro.

The user manual for GHEtool Pro, together with instructions for installation, you can find here.

Image of GHEtool Pro

GHEtool Community

Besides GHEtool Pro, an open-source alternative for the graphical user interface is available in the form of GHEtool Community. This version is built and maintained by the community, and has no official support like GHEtool Pro. You can read all about this GHEtool Community on their GitHub Repo.

.. toctree::
    :caption: GHEtool
    :maxdepth: 1

    self
    sources/cite
    sources/articles
    sources/changelog
    sources/legal_notice


.. toctree::
    :caption: Code
    :maxdepth: 2

    sources/code/getting_started.md
    sources/code/functionalities.md
    sources/code/modules.md
    sources/code/examples.md
    sources/code/validation.md
    sources/code/speed_improvements.md