xpsi-group/xpsi

Change default SaveBackground in method Signal.synthesise

Open

#721 opened on Jul 29, 2026

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (25 forks)auto 404
bugfixgood first issue

Repository metrics

Stars
 (43 stars)
PR merge metrics
 (PR metrics pending)

Description

In the Signal.synthesise method, since the default input background information (data_BKG and expected_background_counts) is None, the default for save_background should be False. Otherwise, Signal.synthesise crashes trying to save a background that is None.

With save_background=False by default, we could either:

  • switch it to True if data_BKG or expected_background_counts are not None
  • add a print to say that the background will not be saved because save_background=False

Contributor guide

Research direction
Find the Signal.synthesise method, review its signature and the logic that uses save background. Update the default to False, and set it to True only when data BKG or expected background counts are provided. Run tests to confirm the fix.
Tech stack
python
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85