ClimaAtmos.jl is a library for building atmospheric circulation models that is designed from the outset to leverage data assimilation and machine learning tools. We welcome contributions!
Add unit tests to ClimaAtmos, and reach a code coverage of 70% in physically meaningful tests.
Cost/Benefits/Risks
Currently, we rely on integration tests in ClimaAtmos to make sure the code works well. Adding unit tests is an important step towards improving the quality of ClimaAtmos code.
People and Personnel
Components
Add unit tests for functions that can be tested in isolation, e.g.
tendencies and closures that have analytical solutions
type stability and allocation of individual functions
Add a small subset of integration tests with increasing complexity to make sure all the components can run
Note: The regression test we currently have can probably be improved too, but we do not plan to change it in this SDI.
Inputs
Results and Deliverables
ClimaAtmos code coverage of 70% or more
Task Breakdown And Schedule
### Scope of Work
- [ ] https://github.com/CliMA/ClimaAtmos.jl/issues/2719
SDI Revision Log
Coverage as at 240429: 40% (up 2% QoQ)
CC
@tapios @simonbyrne @cmbengue
@sriharshakandala Please feel free to edit this SDI, thanks!
The Climate Modeling Alliance
Software Design Issue 📜
Purpose
Add unit tests to ClimaAtmos, and reach a code coverage of 70% in physically meaningful tests.
Cost/Benefits/Risks
Currently, we rely on integration tests in ClimaAtmos to make sure the code works well. Adding unit tests is an important step towards improving the quality of ClimaAtmos code.
People and Personnel
Components
Inputs
Results and Deliverables
Task Breakdown And Schedule
SDI Revision Log
CC
@tapios @simonbyrne @cmbengue @sriharshakandala Please feel free to edit this SDI, thanks!