A template repository to kickstart your finite-element applications with Feel++.
-
**C** example apps using Feel and its toolboxes (located in
src/). -
Python Jupyter notebooks under
docs/notebooks/for interactive demos. -
Documentation authored in AsciiDoc and published with Antora (
docs/). -
Docker setup for reproducible development and deployment.
-
CI via GitHub Actions: C++ tests, Python wheel builds, docs site.
-
CMake ≥ 3.21
-
A C++ compiler (GCC or Clang) with MPI support
-
Python 3.8+ and
pip -
Docker (optional, for container builds)
Our GitHub Actions workflow (.github/workflows/ci.yml) includes:
-
build_wheel: Python wheel compilation and artifact upload.
-
docs: Builds the Antora site, deploys to GitHub Pages on master.
-
build_code: CMake build, tests with ctest --preset default, packaging.
-
deliver: Docker image build & push to GHCR.
-
release: On tags vX.Y.Z, publishes binaries, wheels, datasets, and creates a GitHub release.
Project version is centrally defined in:
-
CMakeLists.txt
-
docs/antora.yml
-
docs/package.json
We welcome contributions! Please:
-
Fork the repository and create a feature branch.
-
Adhere to existing coding conventions; add C++ tests where appropriate.
-
Update documentation (docs/) for any new features.
-
Submit a pull request with a clear description of your changes.