Added suggested chances

Added transient efficiency to DES detection probability

changed DES.py name to des.py

Author: Little-Ryugu

src/sorcha/modules/DESDetectionProbability.py

@@ -20,10 +20,10 @@
 import numpy as np
 
 
-def DEScalcDetectionProbability(mag, limmag, c, k):
+def DEScalcDetectionProbability(mag, limmag, c, k, c_sharp=0.9555):
     """
     Find the probability of a detection given a visual magnitude,
-    limiting magnitude, a scaling factor c, and transition sharpness k. Equation from
+    limiting magnitude, a scaling factor c, transition sharpness k and a transient efficiency. Equation from
     Bernardinelli et al., 2022
 
     Parameters
@@ -40,13 +40,15 @@ def DEScalcDetectionProbability(mag, limmag, c, k):
     k : float or array of floats
         transition sharpness
 
+    c_sharp: float
+        transient efficiency.
     Returns
     ----------
     P : float or array of floats
         Probability of detection.
     """
 
-    P = c / (1 + np.exp(k * (mag - limmag)))
+    P = c_sharp * (c / (1 + np.exp(k * (mag - limmag))))
 
     return P
 

src/sorcha_cmdline/run.py

@@ -153,7 +153,7 @@ def execute(args):
         update_activity_subclasses,
         update_lc_subclasses,
     )
-    from sorcha.DES import runDESSimulation
+    from sorcha.des import runDESSimulation
     import sys, os
 
     # Extract the output file path now in order to set up logging.

tests/sorcha/test_DESDetectionProbaility.py

@@ -6,12 +6,12 @@ def test_DEScalcDetectionProbability():
     mag, limmag, c, k = 20,23.1,0.90,4.55
     P = DEScalcDetectionProbability(mag,limmag,c,k)
 
-    assert math.isclose(P, 0.8999993262,rel_tol=1e-10)
+    assert math.isclose(P, 0.8599493561841001,rel_tol=1e-10)
 
     mag, limmag, c, k = 24,23.1,0.90,3.99
     P = DEScalcDetectionProbability(mag,limmag,c,k)
 
-    assert math.isclose(P, 0.0241478958,rel_tol=1e-10)
+    assert math.isclose(P, 0.0230733144369,rel_tol=1e-10)
 
 
 
@@ -26,6 +26,6 @@ def test_DESDectionProbability():
     obs = pd.DataFrame(obs)
     P = DESDetectionProbability(obs)
 
-    assert math.isclose(P[0], 0.8999993262,rel_tol=1e-10)
+    assert math.isclose(P[0], 0.8599493561841001,rel_tol=1e-10)
 
-    assert math.isclose(P[1], 0.0241478958,rel_tol=1e-10)
+    assert math.isclose(P[1], 0.0230733144369,rel_tol=1e-10)