GenerateFlow

class GenerateFlow.GenerateFlow(*vn, **vn_kwargs)[source]

Generate particle data with anisotropic flow for testing.

This class generates particle lists in JETSCAPE or OSCAR output format to test the correct implementation of flow analysis routines.

Examples

To use the class the GenerateFlow object has to be created with the desired anisotropic flow harmonics and then a dummy data file can be created:

1>>> from GenerateFlow import GenerateFlow
2>>>
3>>> flow_object = GenerateFlow(v2=0.06, v3=0.02, v4=0.03)
4>>> number_events = 100
5>>> event_multiplicity = 10000
6>>> random_seed = 42
7>>> flow_object.generate_dummy_JETSCAPE_file(path_to_output,number_events,event_multiplicity,random_seed)
Attributes:
n_:

Type of flow harmonics.

vn_:

Value of the flow harmonics.

phi_:

List containing the azimuths of the particles.

px_:

Particle momenta in x-direction.

py_:

Particle momenta in y-direction.

pz_:

Particle momenta in z-direction.

Methods

generate_dummy_JETSCAPE_file:

Generate dummy flow data in JETSCAPE format.

generate_dummy_OSCAR_file:

Generate dummy flow data in OSCAR format.

GenerateFlow.generate_dummy_JETSCAPE_file(output_path, number_events, multiplicity, seed)[source]

Generate a dummy JETSCAPE file with random particle momenta.

Parameters:
output_path: str

The output file path.

number_events: int

The number of events to generate.

multiplicity: int

The number of particles per event.

seed: int

The random seed for reproducibility.

Returns:
None
GenerateFlow.generate_dummy_OSCAR_file(output_path, number_events, multiplicity, seed)[source]

Generate a dummy OSCAR2013 file with random particle momenta.

Parameters:
output_path: str

The output file path.

number_events: int

The number of events to generate.

multiplicity: int

The number of particles per event.

seed: int

The random seed for reproducibility.

Returns:
None