You're reading the documentation for a development version. For the latest released version, please have a look at v5.0.1.

Developer Guide

This developer guide is intended to help expand and maintain CADET-Core and is written to serve developers with diverse backgrounds.

If you find any gaps or have suggestions for improvement, your input is valuable in refining our documentation for better comprehension by all developers. Please feel free to open an issue on GitHub or, even better, write a draft and create a pull request.

When planning to extend or contribute to CADET-Core, please adhere to our notation style and research software engineering (RSE) best practices. For detailed guidance, you can e.g. refer to the RSE guidelines. Since some developers may be new to collaborative software development using Git and GitHub, we specifically recommend consulting the Git RSE guide.

• CADET-Python Introduction
  • 0. Preliminary Steps
  • 1. Setting Up the Model
  • 2. Setting up Time Sections and Connections
  • 3. Setting Up the Simulator and Running the Simulation
  • 4. Plotting the Results
  • Exercises
• Software Architecture
  • Features and Capabilities
  • Implementation Details
• CADET build options
  • cmakeSettings.json
  • Options
• Model Expansion
  • Binding Model
  • Unit Operation
  • Testing and Publication
  • Algorithmic differentiation
• CADET-Core debugging
• CADET-Core testing
  • Run the tests
  • Adding tests for your model
  • Maintenance of the tests
• CADET-Core version release
  • Release checklist
  • Release of binaries on conda-forge