Better unit tests for model outputs

Open
#422 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
testing

Research direction

Start by inventorying every model output and the example models available, including the default model. Add unit coverage for successful execution, expected column titles, and relevant validity checks such as zero or NaN values, then run the complete output test suite to confirm all outputs are covered.

Written by the indexing model from the issue text.

Description

infrastructure

There are several issues with the outputs which have gone under the radar. I think one reason for this is that the test coverage for the outputs is poor, and the example models only use a small subset of the tests.

We need to add unit tests for every output, and specifically check:

  • whether the output runs successfully with an example model (e.g. the default model), or several example models
  • check that the column titles are as expected
  • a few other checks where relevant (e.g. no zero or nan values)
Dominant language
Python
Stars
29
Forks
12
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EnergySystemsModellingLab/MUSE_OS

All issues in EnergySystemsModellingLab/MUSE_OS

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.