Add kilonova event source type by Zhengjingyi0823 · Pull Request #445 · LSST-strong-lensing/slsim

Zhengjingyi0823 · 2026-07-09T16:38:12Z

This PR adds a Redback-based Kilonova light-curve wrapper and integrates it as a new KilonovaEvent source type. It also registers the new "kilonova" keyword in source.py and adds tests for the kilonova model and event-level behavior.

Zhengjingyi0823 · 2026-07-09T20:13:57Z

The remaining CI failures seem unrelated to the kilonova changes. The failing tests are in the lens/profile and plotting parts.

I also added redback to requirements.txt because the CI environment did not have it installed, and the new kilonova model depends on it. One concern is that kilonova is an optional source type, so I wonder whether redback should be handled as an optional dependency instead of being required for all SLSim users. Please let me know which approach you prefer.

sibirrer · 2026-07-09T20:18:43Z

Yes, I think I can fix the CI with my big change all at once

…vent

sibirrer

Thank you very much!
I could resolve the merge conflict with the new refactoring. I have some minor request before the merge

sibirrer · 2026-07-22T01:36:08Z

 pyyaml
 matplotlib
+redback>=1.17.0
+colossus


Suggested change

colossus

sibirrer · 2026-07-22T01:36:57Z

 speclite
 pyyaml
 matplotlib
+redback>=1.17.0


this is a very specific package only for kilonovae. Might be better to have it only in the test_requirements.txt

sibirrer · 2026-07-22T01:37:48Z

+        :param model_name: The kilonova light curve model to be used. If not provided,
+            the default model is the MOSFiT-based kilonova model.
+        :type model_name: str
+        :param ejecta_mass: Ejecta masses for the kilonova components.


can you provide the units?

sibirrer · 2026-07-22T01:37:58Z

+        :type model_name: str
+        :param ejecta_mass: Ejecta masses for the kilonova components.
+        :type ejecta_mass: array-like or None
+        :param ejecta_velocity: Ejecta velocities for the kilonova components.


sibirrer · 2026-07-22T01:38:16Z

+        :type ejecta_velocity: array-like or None
+        :param opacity: Opacities for the kilonova components.
+        :type opacity: array-like or None
+        :param temperature_floor: Temperature floors for the kilonova components.


sibirrer · 2026-07-22T01:40:23Z

+        for name, values in parameter_groups.items():
+            if values is None:
+                raise ValueError(f"{name} must be provided.")
+            if len(values) != 3:


why is this test here? Why are there three values? Can you explain what you test here in the code?

sibirrer · 2026-07-22T01:41:31Z

+        self._model_name = model_name
+        self._mag_zpsys = mag_zpsys
+        self._modeldir = modeldir
+        self._kwargs_kilonova = kwargs_kilonova or {}


is this proper python or what does the 'or' do here?

sibirrer · 2026-07-22T01:42:19Z

+                times = self._lightcurve_time
+
+                # Use the sncosmo band-name mapping since Redback expects registered filter names.
+                provided_band = get_sncosmo_filtername(element)


do we need SNCosmo band names? don't understand how this is required

…vent

…onova-event # Conflicts: # requirements.txt

sibirrer · 2026-07-28T20:47:06Z

+                raise ValueError(f"{name} must have three components.")
+
+        self._model_parameters = {
+            "mej_1": ejecta_mass[0],


perhaps have all these parameters as inputs to this class instead of re-naming them

sibirrer · 2026-08-04T13:28:46Z

Thank you @Zhengjingyi0823 ! The CI fails because some tests were not updated

…vent

… into add-kilonova-event

sibirrer · 2026-08-06T18:45:47Z

From a quick search, perhaps add in the test files where the plots are generated these lines of code:
import matplotlib.pyplot as plt

plt.rcParams['text.usetex'] = False

Zhengjingyi0823 · 2026-08-06T20:10:16Z

I added the suggested Matplotlib setting to the plot test file. However, GitHub Actions seems to be experiencing an outage. I tried pushing several times today, but the checks were either stuck in the queue or cancelled. Should I try rerunning them tomorrow?

sibirrer

Yeah, the GitHub action is either down or we are out of credits. Perhaps we wait and try tomorrow again to merge it

sibirrer · 2026-08-06T20:22:19Z

 speclite
 pyyaml
-matplotlib
+matplotlib==3.11.1


do you still need that with the additional fix of not using latex?
I also added trough a separate PR #466 the pit.rcparams parts. Surprised it did not result in a merge conflict or pre-commit cit.

…vent

codecov · 2026-08-08T01:07:29Z

Codecov Report

❌ Patch coverage is 94.87179% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 98.57%. Comparing base (629c2a4) to head (c288567).
⚠️ Report is 11 commits behind head on main.

Files with missing lines	Patch %	Lines
slsim/Sources/SourceTypes/point_source.py	50.00%	2 Missing ⚠️
slsim/Sources/Events/BNSMerger/kilonova.py	94.73%	1 Missing ⚠️
slsim/Sources/SourceTypes/kilonova_event.py	98.03%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #445      +/-   ##
==========================================
- Coverage   98.62%   98.57%   -0.06%     
==========================================
  Files         112      114       +2     
  Lines        8733     8822      +89     
==========================================
+ Hits         8613     8696      +83     
- Misses        120      126       +6

Files with missing lines	Coverage Δ
slsim/Sources/source.py	`100.00% <100.00%> (ø)`
slsim/Sources/Events/BNSMerger/kilonova.py	`94.73% <94.73%> (ø)`
slsim/Sources/SourceTypes/kilonova_event.py	`98.03% <98.03%> (ø)`
slsim/Sources/SourceTypes/point_source.py	`90.90% <50.00%> (-5.76%)`	⬇️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sibirrer · 2026-08-08T01:27:20Z

Ok, looks good now. Just one test that through Source() you can enable the BNS class needs to be tested (two missing lines in the tests) - thank you!

Zhengjingyi0823 and others added 3 commits July 9, 2026 12:31

Add kilonova event source type

bdd12a4

Autofix formatting from pre-commit.com hooks

8ad3f80

Add redback dependency

9d6d3a7

Zhengjingyi0823 requested a review from sibirrer July 9, 2026 20:14

Merge remote-tracking branch 'slsim-project/main' into add-kilonova-e…

e648e85

…vent

Zhengjingyi0823 force-pushed the add-kilonova-event branch from 97907ee to e648e85 Compare July 16, 2026 16:24

Merge branch 'main' into add-kilonova-event

04d8905

sibirrer requested changes Jul 22, 2026

View reviewed changes

Zhengjingyi0823 and others added 5 commits July 27, 2026 23:57

Merge remote-tracking branch 'slsim-project/main' into add-kilonova-e…

5e69347

…vent

Merge remote-tracking branch 'slsim-project/main' into add-kilonova-e…

da6ef0b

…vent

Add lensed kilonova source support

e5c69e7

Merge remote-tracking branch 'origin/add-kilonova-event' into add-kil…

33c33b2

…onova-event # Conflicts: # requirements.txt

Autofix formatting from pre-commit.com hooks

9231372

sibirrer reviewed Jul 28, 2026

View reviewed changes

Zhengjingyi0823 and others added 3 commits July 30, 2026 12:21

Set zero flux outside kilonova light curve

b8f2c6d

Update kilonova model inputs to scalar parameters

6e4e9ad

Autofix formatting from pre-commit.com hooks

a5249f7

Zhengjingyi0823 added 4 commits August 4, 2026 23:52

Merge remote-tracking branch 'slsim-project/main' into add-kilonova-e…

e99095f

…vent

Update kilonova event tests

db6a796

Improve kilonova parameter docstrings

eb0d744

Merge branch 'add-kilonova-event' of github.com:Zhengjingyi0823/slsim…

bdaecf8

… into add-kilonova-event

Zhengjingyi0823 force-pushed the add-kilonova-event branch 2 times, most recently from 205f7f6 to 15e8d07 Compare August 6, 2026 18:03

Autofix formatting from pre-commit.com hooks

c21b3bc

Zhengjingyi0823 force-pushed the add-kilonova-event branch from 15e8d07 to c21b3bc Compare August 6, 2026 19:41

Autofix formatting from pre-commit.com hooks

a4af741

Rerun CI checks

89b3e43

sibirrer reviewed Aug 6, 2026

View reviewed changes

Zhengjingyi0823 added 2 commits August 7, 2026 16:58

Remove matplotlib version pin

f16eebb

Merge remote-tracking branch 'slsim-project/main' into add-kilonova-e…

7b455fd

…vent

Zhengjingyi0823 force-pushed the add-kilonova-event branch from b1854db to 7b455fd Compare August 8, 2026 00:36

Autofix formatting from pre-commit.com hooks

c288567

Uh oh!

Conversation

Zhengjingyi0823 commented Jul 9, 2026

Uh oh!

Zhengjingyi0823 commented Jul 9, 2026

Uh oh!

sibirrer commented Jul 9, 2026

Uh oh!

sibirrer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sibirrer commented Aug 4, 2026

Uh oh!

sibirrer commented Aug 6, 2026

Uh oh!

Zhengjingyi0823 commented Aug 6, 2026

Uh oh!

sibirrer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Aug 8, 2026

Codecov Report

Uh oh!

sibirrer commented Aug 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants