Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add a `reproduce` command

Open
#1,289 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
rust
Domain
cli, testing

Research direction

Start by reading the existing regression-test machinery and the run command entry point, then review related issues #1109 and #1186. Define whether this is a reproduce command or a --reproduce flag, how output-file differences are reported, and how configurable floating-point tolerance works; done means given inputs can be compared against MUSE2 output files with those details.

Written by the indexing model from the issue text.

Description

enhancement

It would be nice if we had a single command to try to reproduce MUSE2 output files for given input files. We could repurpose some of the machinery we have for regression tests to provide details about which files differ and where. As with regression tests, there should be some tolerance to small differences in floating-point numbers (this should probably be configurable, too).

I'm not totally wedded to this being a separate command. We could add a --reproduce flag to the run command or something instead.

Here are a few applications of this feature I can think of:

  • For researchers: Trying to reproduce other researchers' results. (If we make it easy enough, surely everyone will do it... right? 😄)
  • For developers: Helpful for debugging a model that's not working for someone
  • Checking if/how results change between different versions of MUSE2 (obvs this won't be resistant to breaking changes in file formats, but hopefully these will end up being less common in future)

Other issues that might be relevant to this:

  • #1109
  • #1186
Dominant language
Rust
Stars
8
Forks
5
Avg merge
11h 31m
Merged PRs (30d)
33

Contributor guide

Open the contributing guide

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/MUSE2

All issues in EnergySystemsModellingLab/MUSE2

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.