Met.3D Documentation Release 1.0.1 Met.3D documentation contributors Nov 27, 2019 User Documentation 1 Release notes 3 2 Getting started 5 3 Met.3D Linux installation 7 3.1 A) Install available dependencies via your package manager......................8 3.2 B) Install required libraries from their sources..............................9 3.3 C) Download source and data packages................................. 10 3.4 D) Checkout Met.3D from the GIT repository.............................. 11 3.5 E) Configure cmake for Met.3D..................................... 12 3.6 F) Compile Met.3D........................................... 12 3.7 G) Start Met.3D............................................. 12 3.8 H) Test compilation in a Docker container................................ 13 4 First steps with Met.3D 15 4.1 Starting Met.3D............................................. 15 4.2 Adding actors to the scene........................................ 15 4.3 Working with scenes and scene views.................................. 19 4.4 Adding forecast data to the scene.................................... 21 5 Met.3D actors 31 5.1 Graticule................................................. 31 5.2 Basemap................................................. 32 5.3 Volume bounding box.......................................... 34 5.4 1D transfer function (Colour map).................................... 35 5.5 Horizontal sections............................................ 35 5.6 Vertical sections............................................. 36 5.7 Surface topography............................................ 37 5.8 Volume actor............................................... 37 5.9 Movable poles.............................................. 38 5.10 Trajectory actor.............................................. 39 6 Supported data and file formats 41 6.1 Internal data formats in Met.3D..................................... 41 6.2 Gridded data in NetCDF format..................................... 42 6.3 Gridded data in GRIB format...................................... 44 6.4 Trajectory data in NetCDF format.................................... 45 i 7 About Met.3D 47 8 Contributors 49 9 Met.3D developer documentation 51 9.1 Contribution............................................... 51 9.2 Architecture documentation....................................... 51 10 Met.3D contribution guidelines 53 10.1 GIT workflow.............................................. 53 10.2 C++ coding style............................................. 54 10.3 GLSL coding style............................................ 61 11 Architecture 65 11.1 Architecture overview.......................................... 65 11.2 Data analysis framework......................................... 65 ii Met.3D Documentation, Release 1.0.1 Main webpage This is the Met.3D open documentation. See the Met.3D main webpage for more information. Met.3D is an open-source visualisation tool for interactive, three-dimensional visualisation of numerical ensem- ble weather predictions and similar numerical atmospheric model datasets. The tool is implemented in C++ and OpenGL 4 and runs on standard commodity hardware. Its only “special” requirement is an OpenGL 4.3 capable graphics card. Note: Met.3D is open-source, and available on Gitlab. The software is licensed under the GNU General Public License, Version 3. Met.3D currently runs under Linux. It has originally been designed for weather forecasting during atmospheric re- search field campaigns, however, is not restricted to this application. Besides being used as a visualisation tool, Met.3D is intended to serve as a framework to implement and evaluate new 3D and ensemble visualisation techniques for the atmospheric sciences. Note: A Met.3D reference publication has been published in Geoscientific Model Development and is available online: Rautenhaus, M., Kern, M., Schäfler, A., and Westermann, R.: “Three-dimensional visualization of ensemble weather forecasts – Part 1: The visualization tool Met.3D (version 1.0)”, Geosci. Model Dev., 8, 2329-2353, doi:10.5194/gmd- 8-2329-2015, 2015. Met.3D is currently developed at the Regional Computing Center, Universität Hamburg, Germany. We hope you find the tool useful for your work, too. Please let us know about your experiences. The documentation for Met.3D is organised into the following sections: • User Documentation • Feature Documentation • About Met.3D Information about development is also available: • Developer Documentation Attention: The documentation you are reading is work in progress. We are adding bits and pieces whenever we find time. If you don’t find the information you are looking for, please contact us. If you like to contribute to the documentation, please let us know as well! User Documentation 1 Met.3D Documentation, Release 1.0.1 2 User Documentation CHAPTER 1 Release notes Release notes are listed on the News page of the Met.3D main website. 3 Met.3D Documentation, Release 1.0.1 4 Chapter 1. Release notes CHAPTER 2 Getting started This document will show you how to get up and running with Met.3D, and provide you with a short overview of how to use the software. We provide ready-to-use binaries on the Met.3D downloads page. If you want to compile Met.3D by yourself, please follow the notes provided in the section Met.3D Linux installation. The following sections assume that the tool has been successfully installed. First steps with Met.3D contains a tutorial for the first steps with the Met.3D. Met.3D actors provides an overview of available visualization modules. Note: Please note that Met.3D is being developed within a research project. We do our best to fix bugs in the software. However, you may encounter bugs when using Met.3D. Please let us know about any bug you encounter, so we can improve the software. Please also regularly check for software and user guide updates. Note: There is more functionality in Met.3D (in part experimental) than described in this user guide. We will complete the user guide in the future. 5 Met.3D Documentation, Release 1.0.1 6 Chapter 2. Getting started CHAPTER 3 Met.3D Linux installation This page provides installation guidelines for installing Met.3D on openSUSE and Ubuntu Linux systems using the cmake build system. Met.3D requires a number of libraries to be installed and a few external data packages to be downloaded. Most of these packages can be installed via the respective system package managers (YaST or aptitude), however, a few have to be downloaded and compiled manually. Note: The following installation guidelines have been tested with Met.3D 1.5 under openSUSE 15.0 and Ubuntu 18.04 LTS. Note: If you have Docker available on your system, you can test the Met.3D compilation using a Docker image. An example using an Ubuntu image is provided at the end of this page. System requirements: You will need an OpenGL 4.3 capable graphics card and an appropriate Linux driver to run Met.3D. The driver will most likely be a proprietary driver (Nvidia or AMD); open-source drivers for Linux currently do not provide the required capabilities. Before you continue with the installation, make sure that graphics card and driver are installed. If everything is installed correctly, the glxinfo command should output something similar to (the important thing is the OpenGL core profile version > 4.3): glxinfo| grep OpenGL OpenGL vendor string: NVIDIA Corporation OpenGL renderer string: GeForce GTX TITAN/PCIe/SSE2 OpenGL core profile version string: 4.4.0 NVIDIA 340.96 OpenGL core profile shading language version string: 4.40 NVIDIA via Cg compiler 7 Met.3D Documentation, Release 1.0.1 3.1 A) Install available dependencies via your package manager 3.1.1 1) openSUSE For openSUSE 15.0, the following additional repository is required to obtain the ECMWF eccodes library (similar for other openSUSE versions): • http://download.opensuse.org/repositories/home:/SStepke/openSUSE_Leap_15.0/ The repository can be added in the “Software Repositories” windows in YaST. Afterwards, the following packages can be installed in the “Software Management” window (or on the command line). • libqt5-qtbase-devel (or, for Met.3D versions < 1.3: libqt4 and libqt4-devel) - and further packages for Qt5 development • liblog4cplus and log4cplus-devel • gdal, libgdal20 and libgdal-devel • netcdf, netcdf-devel, libnetcdf_c++4-devel, libnetcdf_c++4-1 • hdf5, libhdf5 and hdf5-devel • glew and glew-devel • libfreetype6 and freetype2-devel • eccodes and eccodes-devel (or, for Met.3D versions < 1.3: grib_api and grib_api-devel) • libGLU1 • gsl and gsl_devel • software development basics (gcc, gfortran, git, wget, zip) 3.1.2 2) Ubuntu For Ubuntu 18.04, the following packages need to be installed via aptitude: • qt5-default • liblog4cplus-dev • libgdal-dev • libnetcdf-dev • libnetcdf-c++4-dev • libeccodes-dev • libfreetype6-dev • libgsl-dev • libglew-dev • software development basics (packages build-essential, gfortran, git, wget, zip) 8 Chapter 3. Met.3D Linux installation Met.3D Documentation, Release 1.0.1 3.2 B) Install required libraries from their sources The dependencies glfx and qcustomplot are for both systems not available (at least not in the requried versions). They need to be complied manually. Note: Install both libraries to places where cmake for Met.3D can find them (/your/target/dir in the com- mands listed below). If you are unsure, use a subdirectory of the met-3d-base directory introduced in the next section, e.g. ~\met.3d-base\local. 3.2.1 1) glfx Get the glfx sources from https://code.google.com/p/glfx/