home

---

title: openCFS Wiki

Wiki for openCFS related information like development workflow, coding rules, ... Please don't hesitate to add information. Make sure to include a link to new pages below!

If you just want to just use openCFS, you can download the most recent builds from the pipeline.

Getting Started

This section describes how to

• Get the Source Code
• Configure and Build
• Build on Windows via GUI
• Build on Windows via Terminal
• Setup your editor: VScode or Eclipse
• Installation of required tools like ParaView
• C++ And Coding Literature
• Starting to code in openCFS

A good option to get started with actual implementations is to participate in our regular mob coding sessions.

ParaView

Paraview is the most widely used post-processing tool for openCFS, the .cfs file integration through the CFSReader plugin is discussed here.

CFS Development (Advanced Topics)

This section lists some advanced topics for openCFS developers. Maybe someone solved your problem before?

• Git Workflow
• Pipeline Hints and tricks w.r.t the gitlab pipeline
• Windows Pipeline
• StyleGuide
• Create installation packages
• Coder FAQ
• Code Optimization
• CFSDEPS - handling (precompiled) dependencies
• Ninja an alternative build system
• Embedded Python use the embedded Python interpreter in openCFS
• Testing
  • Testsuite
  • CDash
  • GitLab CI
  • Run docker locally
• Eclipse using Eclipse
• VScode using VScode
• ccache speed up (re-)compilation by using a cache
• finding unused code
• Logging
• Reading xml input
• dependencies and licenses

Helper Scripts

This is a collection of of small helper scripts and their documentation.

• Optimization gradient check
• Benchmarks Compare the speed of your machine

Example Implementation Projects

• CFSdat Processing Multiple Results