https://github.com/cadet/cadet-verification

Extensive tests suite, including order-of-convergence, high-precision reference solutions, and case studies to verify all CADET submodules, in particular the simulation engine(s).
https://github.com/cadet/cadet-verification

Last synced: 19 days ago
JSON representation

Extensive tests suite, including order-of-convergence, high-precision reference solutions, and case studies to verify all CADET submodules, in particular the simulation engine(s).

• Host: GitHub
• URL: https://github.com/cadet/cadet-verification
• Owner: cadet
• License: gpl-3.0
• Created: 2024-10-24T08:58:39.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-20T11:36:16.000Z (about 1 month ago)
• Last Synced: 2024-11-20T12:39:56.113Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 136 KB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CADET-Verification

This repository is subjected to the CADET-Core simulator and includes a comprehensive suite of tests that extend beyond the scope of a typical CI pipeline.

CADET-Verification verifies the implementation, models and methods within CADET-Core via order-of-convergence tests and the recreation of validated case studies.

CADET-Verification is part of the deployment pipeline of CADET-Core and must additionally be run on demand, i.e. when critical changes are made to the simulator.

This repository is solely dedicated to verification.

Computational performance benchmarks are defined and tracked in the [CADET-Benchmark](https://github.com/cadet/CADET-Benchmark) repository.

The research data generated by CADET-Verification is automatically managed using [CADET-RDM](https://jugit.fz-juelich.de/IBG-1/ModSim/cadet/CADET-RDM).

The results of the verification studies can be accessed in the [CADET-Verification-Output](https://github.com/cadet/CADET-Verification-Output) repository.

## Usage

CADET-Verification must be run for deployment and on demand, specifically when critical changes are made to the simulator.

The tests are located in the `src` folder.

The main script is called `verify_cadet-core`, please refer to the documentation therein for further instruction.

The reference data used in some of the tests implemented in CADET-Core can be generated using the corresponding tests defined in CADET-Verification.

## Contributing

We welcome and appreciate all contributions!

If you are a CADET-Core developer adding a new feature, you must also include an appropriate set of verification tests or case studies in this repository.

This ensures that your contribution meets the quality standards and helps maintain the long-term reliability and maintainability of the project.

Furthermore, contributions aimed at improving or extending the evaluation functions are highly encouraged.