PyREx API

The API documentation here is split into three sections. First, the PyREx Package Imports section documents all classes and functions that are imported by PyREx under a from pyrex import * command. Next, the Individual Module APIs section is a full documentation of all the modules which make up the base PyREx package. And finally, the Included Custom Sub-Packages section documents the custom subpackages included with PyREx by default.

PyREx Package Imports

Signal	Base class for time-domain signals.
EmptySignal	Class for signal with zero amplitude (all values = 0).
FunctionSignal	Class for signals generated by a function.
AskaryanSignal	alias of pyrex.askaryan.ARZAskaryanSignal
ThermalNoise	alias of pyrex.signals.FFTThermalNoise
Antenna	Base class for antennas.
DipoleAntenna	Class for half-wave dipole antennas.
AntennaSystem	Base class for antenna system with front-end processing.
Detector	Base class for detectors for easily building up sets of antennas.
ice	Class describing the ice at the south pole.
earth	Class describing the Earth’s density.
NeutrinoInteraction	alias of pyrex.particle.CTWInteraction
Particle	Class for storing particle attributes.
Event	Class for storing a tree of Particle objects representing an event.
CylindricalGenerator	Class to generate neutrino vertices in a cylindrical ice volume.
RectangularGenerator	Class to generate neutrino vertices in a rectangular ice volume.
ListGenerator	Class to generate neutrino events from a list.
FileGenerator	Class to generate neutrino events from simulation file(s).
RayTracer	alias of pyrex.ray_tracing.SpecializedRayTracer
RayTracePath	alias of pyrex.ray_tracing.SpecializedRayTracePath
EventKernel	High-level kernel for controlling event simulation.
File	Class for reading or writing data files.

Individual Module APIs

• Helper Functions (pyrex.internal_functions)
• Signal Processing (pyrex.signals)
• Askaryan Models (pyrex.askaryan)
• Antennas (pyrex.antenna)
• High-level Detectors (pyrex.detector)
• Earth Models (pyrex.earth_model)
• Ice Models (pyrex.ice_model)
• Ray Tracers (pyrex.ray_tracing)
• Particles and Interaction Models (pyrex.particle)
• Event Generators (pyrex.generation)
• Simulation Kernel (pyrex.kernel)
• Data File I/O (pyrex.io)

Included Custom Sub-Packages

• Askaryan Radio Array (pyrex.custom.ara)
• Antarctic Ross Ice-Shelf Antenna Neutrino Array (pyrex.custom.arianna)
• IceCube Radio Extension (pyrex.custom.irex)
• Layered Ice Models (pyrex.custom.layered_ice)