Developer Documentation

About

This page and directory contain links to various high-level Morfeus developer documentation pages. This content is written in Pythonic Markdown and rendered to HTML by FORD and served at https://sourceryinstitute.github.io/MORFEUS-Source. For more details on writing documentation with FORD, please see the FORD wiki.

Contents

• Getting Started: Information required for building Morfeus from source
  • Prerequisites: Required software libraries and tooling
  • Configuring the Library: Running CMake to configure the Morfeus build, find compilers and optional and required prerequisites
  • Building the Library: Compiling Morfeus from source
  • Running Tests: How to run unit and integration tests with CTest
• High-level FV API and Usage: An overview, discussion and list of the high-level finite volume (FV) framework
• High-level FD API and Usage: An overview, discussion and list of the high-level finite difference (FD) framework
• Documenting New and Modified Code: How to write FORD documentation, and what documentation is required in contributed code
• Style Guide: Style requirements, many of which are enforced with EditorConfig or findent.
• Example Usage: Example code and discussion on how to use Morfeus in your application