-
Notifications
You must be signed in to change notification settings - Fork 336
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Adding another MCnet project for 2024 * fix typo * Apply suggestions from code review Co-authored-by: Valentin Volkl <[email protected]> * remove rogue bullets --------- Co-authored-by: Valentin Volkl <[email protected]>
- Loading branch information
Showing
1 changed file
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
title: MCnet/YODA - Improved unit testing and coverage reports from CI | ||
layout: gsoc_proposal | ||
project: MCnet | ||
year: 2024 | ||
organization: | ||
- UCL | ||
difficulty: medium | ||
duration: 175 | ||
mentor_avail: June-October | ||
--- | ||
|
||
# Description | ||
|
||
YODA is a lightweight library for efficient multi-dimensional histogramming | ||
and binned data analysis. It provides a lightweight common system for | ||
Monte Carlo event generator validation analyses, particularly as the | ||
core histogramming library used by the [Rivet](https://yoda.hepforge.org) | ||
analysis toolkit. | ||
|
||
|
||
## Task ideas | ||
|
||
This project will improve the robustness of the YODA library and | ||
release system through automated unit-test coverage reports | ||
by the GitLab continuous integration system, and web-based | ||
visualization of what code areas need better monitoring. | ||
|
||
|
||
## Expected results and milestones | ||
|
||
* Familiarise with the YODA library; | ||
* Familiarise with the YODA unit test system, including current CI scripts; | ||
* Hook up existing unit tests with `gcov` and produce a coverage estimate; | ||
* Visualize coverage reports and produce web-based status displays; | ||
* Trigger automated coverage checks and visual displays in the CI. | ||
|
||
## Requirements | ||
|
||
* C++ | ||
* CI testing | ||
* git | ||
|
||
|
||
## Mentors | ||
|
||
* **[Christian Gutschow](mailto:[email protected])** | ||
|
||
|
||
## Links | ||
|
||
* [YODA](https://yoda.hepforge.org) |