Move all reco-specific logic to reco modules [minor]

.github/workflows/tests.yml

@@ -272,7 +272,7 @@ jobs:
         ]
         reco_algo: [
           millipede_original,
-          # millipede_wilks,
+          millipede_wilks,
           # splinempe
         ]
     env:
@@ -395,8 +395,8 @@ jobs:
         ]
         reco_algo:
             [
-              "millipede_original",
-              # "millipede_wilks"
+              millipede_original,
+              millipede_wilks,
               # "splinempe"
             ]
     steps:

README.md

@@ -70,7 +70,7 @@ export EWMS_PILOT_TASK_TIMEOUT=1200
     --client-startup-json PATH_TO_CLIENT_STARTUP_JSON \
     --cache-dir `pwd`/server_cache \
     --output-dir `pwd` \
-    --reco-algo millipede \
+    --reco-algo millipede_original \
     --event-file `pwd`/run00136662-evt000035405932-BRONZE.pkl  # could also be a .json file
 ```
 _NOTE: The `--*dir` arguments can all be the same if you'd like. Relative paths are also fine._
@@ -220,7 +220,7 @@ Relatedly, the environment variable `EWMS_PILOT_TASK_TIMEOUT` & `EWMS_PILOT_QUAR
 There are more command-line arguments than those shown in [Example Startup](#example-startup). See `skymap_scanner.server.start_scan.main()` and `skymap_scanner.client.client.main()` for more detail.
 
 #### Runtime-Configurable Reconstructions
-Recos are registered by being placed in a dedicated module within the `skymap_scanner.recos` sub-package. Each module must contain a class of the same name (eg: `skymap_scanner.recos.foo` has `skymap_scanner.recos.foo.Foo`) that fully inherits from `skymap_scanner.recos.RecoInterface`. This includes implementing the static methods: `traysegment()` (for IceTray) and `to_pixelreco()` (for MQ). Specialized reco-specific logic in the upstream/pixel-generation phase is done on an ad-hoc basis, eg: `if reco_algo == 'millipede_original': ...`. On the command line, choosing your reco is provided via `--reco-algo` (on the server).
+Recos are registered by being placed in a dedicated module within the `skymap_scanner.recos` sub-package. Each module must contain a class of the same name (eg: `skymap_scanner.recos.foo` has `skymap_scanner.recos.foo.Foo`) that fully inherits from `skymap_scanner.recos.RecoInterface`. This includes implementing the static methods: `traysegment()` (for IceTray) and `to_pixelreco()` (for MQ). The reco-specific logic in the upstream/pixel-generation phase is defined in the same class by the `prepare_frames()` (pulse cleaning, vertex generation) and `get_vertex_variations()` (variations of the vertex positions to be used as additional seeds for each pixel). On the command line, choosing your reco is provided via `--reco-algo` (on the server).
 
 ## Making Branch-Based Images for Production-like Testing
 If you need to test your updates in a production-like environment at a scale that isn't provided by CI, then create a branch-based image. This image will be available on Docker Hub and CVMFS.

requirements-all.txt

@@ -20,7 +20,7 @@ charset-normalizer==3.1.0
     # via requests
 coloredlogs==15.0.1
     # via wipac-dev-tools
-contourpy==1.0.7
+contourpy==1.1.0
     # via matplotlib
 cryptography==41.0.1
     # via pyjwt
@@ -44,7 +44,7 @@ icecube-skyreader==1.2.0
     # via skymap-scanner (setup.py)
 idna==3.4
     # via requests
-iminuit==2.21.3
+iminuit==2.22.0
     # via skymap-scanner (setup.py)
 kiwisolver==1.4.4
     # via matplotlib
@@ -58,7 +58,7 @@ nats-py[nkeys]==2.3.1
     # via oms-mqclient
 nkeys==0.1.0
     # via nats-py
-numpy==1.24.3
+numpy==1.25.0
     # via
     #   astropy
     #   contourpy
@@ -78,11 +78,11 @@ packaging==23.1
     # via
     #   astropy
     #   matplotlib
-pandas==2.0.2
+pandas==2.0.3
     # via icecube-skyreader
 pika==1.3.2
     # via oms-mqclient
-pillow==9.5.0
+pillow==10.0.0
     # via matplotlib
 pulsar-client==3.2.0
     # via oms-mqclient
@@ -92,7 +92,7 @@ pyerfa==2.0.0.3
     # via astropy
 pyjwt[crypto]==2.7.0
     # via wipac-rest-tools
-pyparsing==3.0.9
+pyparsing==3.1.0
     # via matplotlib
 pypng==0.20220715.0
     # via qrcode
@@ -111,15 +111,15 @@ requests==2.31.0
     #   requests-futures
     #   wipac-dev-tools
     #   wipac-rest-tools
-requests-futures==1.0.0
+requests-futures==1.0.1
     # via wipac-rest-tools
-scipy==1.10.1
+scipy==1.11.1
     # via healpy
 six==1.16.0
     # via python-dateutil
 tornado==6.3.2
     # via wipac-rest-tools
-typing-extensions==4.6.3
+typing-extensions==4.7.1
     # via
     #   qrcode
     #   wipac-dev-tools

requirements-client-starter.txt

@@ -18,7 +18,7 @@ charset-normalizer==3.1.0
     # via requests
 coloredlogs==15.0.1
     # via wipac-dev-tools
-contourpy==1.0.7
+contourpy==1.1.0
     # via matplotlib
 cryptography==41.0.1
     # via pyjwt
@@ -34,15 +34,15 @@ healpy==1.16.2
     #   skymap-scanner (setup.py)
 htchirp==2.0
     # via ewms-pilot
-htcondor==10.5.0
+htcondor==10.6.0
     # via skymap-scanner (setup.py)
 humanfriendly==10.0
     # via coloredlogs
 icecube-skyreader==1.2.0
     # via skymap-scanner (setup.py)
 idna==3.4
     # via requests
-iminuit==2.21.3
+iminuit==2.22.0
     # via skymap-scanner (setup.py)
 kiwisolver==1.4.4
     # via matplotlib
@@ -52,7 +52,7 @@ matplotlib==3.7.1
     #   icecube-skyreader
 meander==0.0.3
     # via icecube-skyreader
-numpy==1.24.3
+numpy==1.25.0
     # via
     #   astropy
     #   contourpy
@@ -72,17 +72,17 @@ packaging==23.1
     # via
     #   astropy
     #   matplotlib
-pandas==2.0.2
+pandas==2.0.3
     # via icecube-skyreader
-pillow==9.5.0
+pillow==10.0.0
     # via matplotlib
 pycparser==2.21
     # via cffi
 pyerfa==2.0.0.3
     # via astropy
 pyjwt[crypto]==2.7.0
     # via wipac-rest-tools
-pyparsing==3.0.9
+pyparsing==3.1.0
     # via matplotlib
 pypng==0.20220715.0
     # via qrcode
@@ -101,15 +101,15 @@ requests==2.31.0
     #   requests-futures
     #   wipac-dev-tools
     #   wipac-rest-tools
-requests-futures==1.0.0
+requests-futures==1.0.1
     # via wipac-rest-tools
-scipy==1.10.1
+scipy==1.11.1
     # via healpy
 six==1.16.0
     # via python-dateutil
 tornado==6.3.2
     # via wipac-rest-tools
-typing-extensions==4.6.3
+typing-extensions==4.7.1
     # via
     #   qrcode
     #   wipac-dev-tools

requirements-nats.txt

@@ -18,7 +18,7 @@ charset-normalizer==3.1.0
     # via requests
 coloredlogs==15.0.1
     # via wipac-dev-tools
-contourpy==1.0.7
+contourpy==1.1.0
     # via matplotlib
 cryptography==41.0.1
     # via pyjwt
@@ -42,7 +42,7 @@ icecube-skyreader==1.2.0
     # via skymap-scanner (setup.py)
 idna==3.4
     # via requests
-iminuit==2.21.3
+iminuit==2.22.0
     # via skymap-scanner (setup.py)
 kiwisolver==1.4.4
     # via matplotlib
@@ -56,7 +56,7 @@ nats-py[nkeys]==2.3.1
     # via oms-mqclient
 nkeys==0.1.0
     # via nats-py
-numpy==1.24.3
+numpy==1.25.0
     # via
     #   astropy
     #   contourpy
@@ -76,17 +76,17 @@ packaging==23.1
     # via
     #   astropy
     #   matplotlib
-pandas==2.0.2
+pandas==2.0.3
     # via icecube-skyreader
-pillow==9.5.0
+pillow==10.0.0
     # via matplotlib
 pycparser==2.21
     # via cffi
 pyerfa==2.0.0.3
     # via astropy
 pyjwt[crypto]==2.7.0
     # via wipac-rest-tools
-pyparsing==3.0.9
+pyparsing==3.1.0
     # via matplotlib
 pypng==0.20220715.0
     # via qrcode
@@ -105,15 +105,15 @@ requests==2.31.0
     #   requests-futures
     #   wipac-dev-tools
     #   wipac-rest-tools
-requests-futures==1.0.0
+requests-futures==1.0.1
     # via wipac-rest-tools
-scipy==1.10.1
+scipy==1.11.1
     # via healpy
 six==1.16.0
     # via python-dateutil
 tornado==6.3.2
     # via wipac-rest-tools
-typing-extensions==4.6.3
+typing-extensions==4.7.1
     # via
     #   qrcode
     #   wipac-dev-tools

requirements-pulsar.txt

@@ -20,7 +20,7 @@ charset-normalizer==3.1.0
     # via requests
 coloredlogs==15.0.1
     # via wipac-dev-tools
-contourpy==1.0.7
+contourpy==1.1.0
     # via matplotlib
 cryptography==41.0.1
     # via pyjwt
@@ -42,7 +42,7 @@ icecube-skyreader==1.2.0
     # via skymap-scanner (setup.py)
 idna==3.4
     # via requests
-iminuit==2.21.3
+iminuit==2.22.0
     # via skymap-scanner (setup.py)
 kiwisolver==1.4.4
     # via matplotlib
@@ -52,7 +52,7 @@ matplotlib==3.7.1
     #   icecube-skyreader
 meander==0.0.3
     # via icecube-skyreader
-numpy==1.24.3
+numpy==1.25.0
     # via
     #   astropy
     #   contourpy
@@ -72,9 +72,9 @@ packaging==23.1
     # via
     #   astropy
     #   matplotlib
-pandas==2.0.2
+pandas==2.0.3
     # via icecube-skyreader
-pillow==9.5.0
+pillow==10.0.0
     # via matplotlib
 pulsar-client==3.2.0
     # via oms-mqclient
@@ -84,7 +84,7 @@ pyerfa==2.0.0.3
     # via astropy
 pyjwt[crypto]==2.7.0
     # via wipac-rest-tools
-pyparsing==3.0.9
+pyparsing==3.1.0
     # via matplotlib
 pypng==0.20220715.0
     # via qrcode
@@ -103,15 +103,15 @@ requests==2.31.0
     #   requests-futures
     #   wipac-dev-tools
     #   wipac-rest-tools
-requests-futures==1.0.0
+requests-futures==1.0.1
     # via wipac-rest-tools
-scipy==1.10.1
+scipy==1.11.1
     # via healpy
 six==1.16.0
     # via python-dateutil
 tornado==6.3.2
     # via wipac-rest-tools
-typing-extensions==4.6.3
+typing-extensions==4.7.1
     # via
     #   qrcode
     #   wipac-dev-tools

requirements-rabbitmq.txt

@@ -18,7 +18,7 @@ charset-normalizer==3.1.0
     # via requests
 coloredlogs==15.0.1
     # via wipac-dev-tools
-contourpy==1.0.7
+contourpy==1.1.0
     # via matplotlib
 cryptography==41.0.1
     # via pyjwt
@@ -40,7 +40,7 @@ icecube-skyreader==1.2.0
     # via skymap-scanner (setup.py)
 idna==3.4
     # via requests
-iminuit==2.21.3
+iminuit==2.22.0
     # via skymap-scanner (setup.py)
 kiwisolver==1.4.4
     # via matplotlib
@@ -50,7 +50,7 @@ matplotlib==3.7.1
     #   icecube-skyreader
 meander==0.0.3
     # via icecube-skyreader
-numpy==1.24.3
+numpy==1.25.0
     # via
     #   astropy
     #   contourpy
@@ -70,19 +70,19 @@ packaging==23.1
     # via
     #   astropy
     #   matplotlib
-pandas==2.0.2
+pandas==2.0.3
     # via icecube-skyreader
 pika==1.3.2
     # via oms-mqclient
-pillow==9.5.0
+pillow==10.0.0
     # via matplotlib
 pycparser==2.21
     # via cffi
 pyerfa==2.0.0.3
     # via astropy
 pyjwt[crypto]==2.7.0
     # via wipac-rest-tools
-pyparsing==3.0.9
+pyparsing==3.1.0
     # via matplotlib
 pypng==0.20220715.0
     # via qrcode
@@ -101,15 +101,15 @@ requests==2.31.0
     #   requests-futures
     #   wipac-dev-tools
     #   wipac-rest-tools
-requests-futures==1.0.0
+requests-futures==1.0.1
     # via wipac-rest-tools
-scipy==1.10.1
+scipy==1.11.1
     # via healpy
 six==1.16.0
     # via python-dateutil
 tornado==6.3.2
     # via wipac-rest-tools
-typing-extensions==4.6.3
+typing-extensions==4.7.1
     # via
     #   qrcode
     #   wipac-dev-tools