:allow_comments: False

.. _doc_installation_index:

Installation
============

.. _install_linux:

Linux
-----

Conda package
~~~~~~~~~~~~~

Our recommended way of installing Met.3D for usage is the binary distribution we provide as
a conda package. This distribution corresponds to the
latest tagged version in the `Met.3D git repository
<https://gitlab.com/wxmetvis/met.3d/-/tags>`_.

.. toctree::
    :maxdepth: 1

    conda

Building Met.3D from source
~~~~~~~~~~~~~~~~~~~~~~~~~~~

To build Met.3D from source, we also recommend using conda to set up a build environment
including the required dependencies.

.. toctree::
    :maxdepth: 1

    src_conda

Windows
-------

Met.3D does support windows natively and can be build from source there. 
We currently do not distribute pre-packed binaries.

Met.3D can also be installed with current versions of the Windows Subsystem for Linux (WSL2), which
does support our binary distributions.

.. toctree::
  :maxdepth: 1

  src_windows
  windows_wsl

MacOS
-----

To the best of our knowledge, Apple only supports OpenGL up to version 4.1.
Since Met.3D uses functionality of version 4.3, adapting the code to run on macOS
would require much effort.
We currently do not have the corresponding resources, but if you would like to
contribute, help would be much appreciated.


Use with external GPUs
----------------------

Many laptop computers do not feature a strong-enough graphics card for Met.3D use.
For our Linux setup with Ubuntu, we successfully managed to run Met.3D using an external
GPU attached via Thunderbolt to the laptop.

.. toctree::
    :maxdepth: 1

    eGPU

Use with remote visualization on HPC systems
--------------------------------------------

Some HPC systems feature remote visualization setups.
Here we describe how Met.3D can be used "Levante" HPC system run by the
German Climate Computing Centre (DKRZ).

.. toctree:: 
  :maxdepth: 1

  levante