Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 2.16 KB

index.rst

File metadata and controls

85 lines (60 loc) · 2.16 KB
Raw

Welcome to Hermes

Thank you for your interest in Hermes!

Hermes is a C++ library for rapid development of adaptive hp-FEM and hp-DG solvers, with emphasis on nonlinear, time-dependent, multi-physics problems.

This document is organized as follows:

  • Section 1 provides general information about Hermes and the computational methods it uses, and gives references to underlying scientific articles.
  • Section 2 describes how to install Hermes on various hardware platforms, and how to install matrix solver packages and various optional packages.
  • Section 3 is the core documentation section, you will find developers documentation in Doxygen, as well as step-by-step user documentation in tutorials and advanced examples.
  • Section 4 explains how to use Git and Github, and how you can contribute to the project if interested.

This document is under continuous development. If you find bugs, typos, dead links and such, please report them to the Hermes2D mailing list.

Introduction

src/about-hermes src/math-background src/web-access src/citing-hermes

Installation

src/installation/linux src/installation/win src/installation/mac src/installation/matrix_solvers src/installation/exodusII_netcdf

Documentation

src/documentation src/typical_example src/documentation-tutorial src/documentation-examples

Collaboration

src/collaboration

Tutorial and Examples

Tutorial and examples are in separate repositories. Before using them, make sure to install the Hermes library in your system. To get the tutorial, clone:

git clone git://github.com/hpfem/hermes-tutorial.git

To get examples, clone:

git clone git://github.com/hpfem/hermes-examples.git

Both repositores contain a folder doc/ with documentation. To build the documentation there, type "make html" in the doc/ directory.