Data

Tools

Indexes

Applications

Experiments

Open Source Science

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

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

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).

Basic Info
  • Host: GitHub
  • Owner: cadet
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 12.4 MB
Statistics
  • Stars: 9
  • Watchers: 2
  • Forks: 1
  • Open Issues: 22
  • Releases: 3
Created over 1 year ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

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.

The research data generated by CADET-Verification is automatically managed using CADET-RDM. The results of the verification studies can be accessed in the CADET-Verification-Output repository.

Usage

CADET-Verification must be executed as part of the CADET-Core release process and on demand, particularly when critical changes are introduced to the simulator.

To trigger a verification run, manually dispatch the verify.yml GitHub Actions workflow. During this process, you must specify the appropriate pytest fixtures. For guidance on available parameters and their default values, refer to the conftest.py file. The input for the workflow for a release verification run might look like this:

--branch-name=release/cadet-core_v504 --small-test=false --rdm-debug-mode=false --rdm-push=true

For release verification runs, ensure the following options are explicitly set:

  • rdm-debug: false
  • small_test: false

Once the workflow completes, the generated verification data will be published to the CADET-Verification-Output repository.

⚠️ Note: There is currently no automated validation of the verification results. Final evaluation must be performed manually by comparing the new output with results from the previous run.

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.The output repo can be found at: output_repo

Owner

  • Name: CADET
  • Login: cadet
  • Kind: organization
  • Email: cadet@fz-juelich.de

GitHub Events

Total
  • Create event: 33
  • Release event: 3
  • Issues event: 19
  • Watch event: 7
  • Delete event: 22
  • Issue comment event: 22
  • Push event: 209
  • Public event: 1
  • Pull request review event: 5
  • Pull request review comment event: 1
  • Pull request event: 66
  • Fork event: 2
Last Year
  • Create event: 33
  • Release event: 3
  • Issues event: 19
  • Watch event: 7
  • Delete event: 22
  • Issue comment event: 22
  • Push event: 209
  • Public event: 1
  • Pull request review event: 5
  • Pull request review comment event: 1
  • Pull request event: 66
  • Fork event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 9
  • Total pull requests: 24
  • Average time to close issues: 6 months
  • Average time to close pull requests: 20 days
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 0.44
  • Average comments per pull request: 0.13
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 9
  • Pull requests: 24
  • Average time to close issues: 6 months
  • Average time to close pull requests: 20 days
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.44
  • Average comments per pull request: 0.13
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • jbreue16 (13)
  • ronald-jaepel (1)
Pull Request Authors
  • jbreue16 (35)
  • hannahlanzrath (1)
  • ronald-jaepel (1)
  • WFlynnZ (1)
Top Labels
Issue Labels
enhancement (8) maintenance (5) meta (2)
Pull Request Labels
enhancement (20) maintenance (11) bug (5) meta (1)

Dependencies

environment.yml pypi
  • cadet-process *
  • cadet-rdm *