Overview of Feel++ Template Project

1. Organisation

The directory structure of the project is as follows:

.
├── docs
│   ├── antora
│   └── modules
└── src
    └── cases

5 directories

  • The docs directory contains the documentation of the project and uses antora to generate the documentation.

  • The src directory contains initially some C++ and Python Feel++ source code of the project to help you get started.

Feel++ is a C++ library for the numerical simulation of partial differential equations. It is designed to be easy to use and to extend. Feel++ is a free software distributed under the terms of the GNU General Public License version 3. The documentation is available > here.

2. How to build the project

You need first to follow the quickstart to get the Feel++ environment. The installation procedure uses Cmake for the C++ programs and create a bundle of this project. The steps are as follows:

$ cmake --preset default (1)
$ cmake --build --preset default (2)
$ cmake --build --preset default -t install (3)
$ ctest --preset default (4)
$ cmake --build --preset default -t package (5)
1 Configure the project
2 Build the project
3 Install the project
4 Run the tests
5 Package the project

3. How to start documenting your work

The documentation is written in AsciiDoc and uses Antora to generate the documentation. Please check the project Antora page to get started.