Introduction

The documentation for Met.3D is organized into the following sections:

Information about development is also available:

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

The user documentation provides Installation instructions, information on First steps with Met.3D and more detailed information about supported data, user interface components, and visualization modules of Met.3D.

In addition, Specific tasks are described, and some examples are presented.

If you are missing information relevant to your work, please let us know!

Developer Documentation

Large parts of the Met.3D source code have already been documented with the Doxygen code documentation system. A Doxygen configuration file is available in the Met.3D repository (in the doc/doxygen subdirectory). Please run Doxygen locally to build the corresponding documentation.

Contribution

If you are contributing to the Met.3D code base, please carefully read the Met.3D contribution guidelines. They contain information on the used GIT workflow and coding conventions. As the project is continuously growing, please adhere to the listed conventions.

Architecture documentation

Conceptual descriptions of the architecture of selected features in Met.3D are provided in Architecture overview. This section will be expanded in the future.