From eb0b80395d8ae72d55c3e90913034433959b9604 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Einar=20El=C3=A9n?= <einar.elen@gmail.com>
Date: Sun, 19 Nov 2023 13:36:27 +0100
Subject: [PATCH] Document upKaons

---
 python/kaon_physics.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/python/kaon_physics.py b/python/kaon_physics.py
index 50ce634..a1d6cb8 100644
--- a/python/kaon_physics.py
+++ b/python/kaon_physics.py
@@ -46,7 +46,15 @@ def __init__(self):
         self.kplus_lifetime_factor = 1.
         self.kminus_lifetime_factor = 1.
 
+
     def upKaons():
+        """Returns a configuration of the kaon physics corresponding
+        to the changes that were made in
+        https://github.com/ldmx-software/geant4/tree/LDMX.upKaons_mod
+
+        Reduces the charged kaon lifetimes by a factor 1/50 and forces
+        decays to be into one of the leptonic decay modes.
+        """
         kaon_physics = KaonPhysics()
         kaon_physics.kplus_branching_ratios = [
             0.8831,  # K^+ -> mu^+ + nu_mu