Add tests and fix event counting for Jetscape

Fix num_output_per_event() so that it starts counting from 0 for Oscar
and from 1 for Jetscape files. Also add test for warning in case of
empty event list.

src/sparkx.egg-info/SOURCES.txt

@@ -0,0 +1,44 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+src/sparkx/CentralityClasses.py
+src/sparkx/EventCharacteristics.py
+src/sparkx/Filter.py
+src/sparkx/Histogram.py
+src/sparkx/Jackknife.py
+src/sparkx/JetAnalysis.py
+src/sparkx/Jetscape.py
+src/sparkx/Lattice3D.py
+src/sparkx/MultiParticlePtCorrelations.py
+src/sparkx/Oscar.py
+src/sparkx/Particle.py
+src/sparkx/Utilities.py
+src/sparkx/__init__.py
+src/sparkx.egg-info/PKG-INFO
+src/sparkx.egg-info/SOURCES.txt
+src/sparkx.egg-info/dependency_links.txt
+src/sparkx.egg-info/requires.txt
+src/sparkx.egg-info/top_level.txt
+src/sparkx/flow/EventPlaneFlow.py
+src/sparkx/flow/FlowInterface.py
+src/sparkx/flow/GenerateFlow.py
+src/sparkx/flow/LeeYangZeroFlow.py
+src/sparkx/flow/PCAFlow.py
+src/sparkx/flow/QCumulantFlow.py
+src/sparkx/flow/ReactionPlaneFlow.py
+src/sparkx/flow/ScalarProductFlow.py
+src/sparkx/flow/__init__.py
+tests/test_CentralityClasses.py
+tests/test_EventCharacteristics.py
+tests/test_Filter.py
+tests/test_Flow.py
+tests/test_Histogram.py
+tests/test_Jackknife.py
+tests/test_JetAnalysis.py
+tests/test_Jetscape.py
+tests/test_Lattice3D.py
+tests/test_MultiParticlePtCorrelations.py
+tests/test_Oscar.py
+tests/test_Particle.py
+tests/test_Utilities.py

src/sparkx.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

src/sparkx.egg-info/requires.txt

@@ -0,0 +1,6 @@
+particle==0.23.0
+numpy>=1.23.5
+scipy>=1.10.1
+abc-property==1.0
+fastjet==3.4.1.3
+matplotlib>=3.7.1

src/sparkx.egg-info/top_level.txt

@@ -0,0 +1 @@
+sparkx

src/sparkx/BaseStorer.py

@@ -560,7 +560,7 @@ def _update_num_output_per_event_after_filter(self) -> None:
             # Handle the case where num_output_per_event_ is a two-dimensional array
             updated_num_output_per_event = np.ndarray((len(self.particle_list_),2), dtype=int)
             for event in range(len(self.particle_list_)):
-                updated_num_output_per_event[event][0] = event
+                updated_num_output_per_event[event][0] = event + self.num_output_per_event_[0][0]
                 updated_num_output_per_event[event][1] = len(
                     self.particle_list_[event]
                 )

src/sparkx/Filter.py

@@ -797,15 +797,15 @@ def spacetime_rapidity_cut(particle_list, cut_value):
 
 def multiplicity_cut(particle_list, cut_value_tuple):
     """
-    Apply multiplicity cut. Remove all events with a multiplicity not coplying
+    Apply multiplicity cut. Remove all events with a multiplicity not complying
     with cut_value_tuple.
 
     Parameters
     ----------
     particle_list:
         List with lists containing particle objects for the events
 
-    multiplicity_range : tuple
+    cut_value_tuple : tuple
         Upper and lower bound for multiplicity. If the multiplicity of an event is
         not in this range, the event is discarded. The range is inclusive on the 
         lower bound and exclusive on the upper bound.

src/sparkx/Jetscape.py

@@ -130,7 +130,7 @@ class Jetscape(BaseStorer):
 
         >>> jetscape = Jetscape(JETSCAPE_FILE_PATH)
         >>>
-        >>> pions = jetscape.multiplicity_cut(500).participants().particle_species((211, -211, 111))
+        >>> pions = jetscape.multiplicity_cut(500, None).participants().particle_species((211, -211, 111))
         >>>
         >>> # save the pions of all events as nested list
         >>> pions_list = pions.particle_list()
@@ -150,7 +150,7 @@ class Jetscape(BaseStorer):
     Let's assume we only want to keep pions in events with a
     multiplicity > 500:
 
-        >>> jetscape = Jetscape(JETSCAPE_FILE_PATH, filters={'multiplicity_cut':500, 'particle_species':(211, -211, 111)}})
+        >>> jetscape = Jetscape(JETSCAPE_FILE_PATH, filters={'multiplicity_cut':(500,None), 'particle_species':(211, -211, 111)}})
         >>>
         >>> # print the pions to a jetscape file
         >>> jetscape.print_particle_lists_to_file('./particle_lists.dat')
@@ -304,6 +304,8 @@ def print_particle_lists_to_file(self, output_file: str) -> None:
             raise ValueError("The number of output per event is empty.")
         if self.num_events_ is None:
             raise ValueError("The number of events is empty.")
+        if self.num_events_ == 0:
+            raise ValueError("The number of events is zero.")
 
         # Open the output file with buffered writing (25 MB)
         with open(output_file, "w", buffering=25 * 1024 * 1024) as f_out:

src/sparkx/Oscar.py

@@ -134,7 +134,7 @@ class Oscar(BaseStorer):
 
         >>> oscar = Oscar(OSCAR_FILE_PATH)
         >>>
-        >>> pions = oscar.multiplicity_cut(500).participants().particle_species((211, -211, 111))
+        >>> pions = oscar.multiplicity_cut(500, None).participants().particle_species((211, -211, 111))
         >>>
         >>> # save the pions of all events as nested list
         >>> pions_list = pions.particle_list()
@@ -154,7 +154,7 @@ class Oscar(BaseStorer):
     Let's assume we only want to keep participant pions in events with a
     multiplicity > 500:
 
-        >>> oscar = Oscar(OSCAR_FILE_PATH, filters={'multiplicity_cut':500, 'participants':True, 'particle_species':(211, -211, 111)})
+        >>> oscar = Oscar(OSCAR_FILE_PATH, filters={'multiplicity_cut':(500,None), 'participants':True, 'particle_species':(211, -211, 111)})
         >>>
         >>> # print the pions to an oscar file
         >>> oscar.print_particle_lists_to_file('./particle_lists.oscar')

src/sparkx/flow/LeeYangZeroFlow.py

@@ -344,7 +344,7 @@ def integrated_flow(self, particle_data):
         AvgQxSqPQySq = 0.0
 
         G = np.zeros(
-            (len(self.theta_space_), len(self.r_space_)), dtype=np.complex_
+            (len(self.theta_space_), len(self.r_space_)), dtype=np.complex128
         )
         self.__sample_random_reaction_planes(len(particle_data))
 
@@ -362,7 +362,7 @@ def integrated_flow(self, particle_data):
             phi_j = [phi + self.rand_reaction_planes_[event] for phi in phi_j]
 
             g = np.zeros(
-                (len(self.theta_space_), len(self.r_space_)), dtype=np.complex_
+                (len(self.theta_space_), len(self.r_space_)), dtype=np.complex128
             )
             for theta in range(len(self.theta_space_)):
                 for r in range(len(self.r_space_)):
@@ -456,7 +456,7 @@ def __compute_reference_differential_flow(self, particle_data):
             # randomize the event plane
             phi_j = [phi + self.rand_reaction_planes_[event] for phi in phi_j]
 
-            g = np.zeros(len(self.theta_space_), dtype=np.complex_)
+            g = np.zeros(len(self.theta_space_), dtype=np.complex128)
             for theta in range(len(self.theta_space_)):
                 g[theta] = self.__g_theta(
                     self.n_,
@@ -535,7 +535,7 @@ def __compute_differential_flow_bin(self, particle_data_bin):
             # randomize the event plane
             phi_j = [phi + self.rand_reaction_planes_[event] for phi in phi_j]
 
-            g = np.zeros(len(self.theta_space_), dtype=np.complex_)
+            g = np.zeros(len(self.theta_space_), dtype=np.complex128)
             for theta in range(len(self.theta_space_)):
                 g[theta] = self.__g_theta(
                     self.n_,

tests/test_Oscar.py

@@ -684,6 +684,16 @@ def test_standard_oscar_print(tmp_path, output_path):
     os.remove(output_path)
 
 
+def test_empty_oscar_print(tmp_path, output_path):
+    tmp_oscar_file = create_temporary_oscar_file(
+        tmp_path, 5, "Oscar2013", [1, 7, 0, 36, 5]
+    )
+    oscar = Oscar(tmp_oscar_file).multiplicity_cut((100000000,None))
+    with pytest.warns(UserWarning):
+        oscar.print_particle_lists_to_file(output_path)
+    os.remove(output_path)
+
+
 def test_extended_oscar_print(tmp_path, output_path):
     tmp_oscar_file = create_temporary_oscar_file(
         tmp_path, 5, "Oscar2013Extended", [4, 1, 42, 0, 3]