miniradiotools

Welcome to the miniradiotools package! It is a minimalistic python package for the basic needs in radio analysis.

Since miniradiotools is meant to be used with CORSIKA (https://web.iap.kit.edu/corsika/usersguide/usersguide.pdf) and its radio extension CoREAS (https://web.ikp.kit.edu/huege/downloads/coreas-manual.pdf), it uses CORSIKA conventions.

It's inspired by the radiotools package: https://github.com/nu-radio/radiotools/ which uses Auger conventions.

Input Parameters

The scripts use GRAND's Dunhuang site as reference for default parameters, but they can easily be changed for any other site.

Magnetic field parameters can be looked up here: https://www.ngdc.noaa.gov/geomag/calculators/magcalc.shtml#igrfwmm

Scripts

antenna_plotter.py

Plots antenna positions from antenna.list files with the structure: AntennaPosition = {x} {y} {z} {name}

plot_traces.py

Plots efield traces from *.dat files produced by Coreas (or with the same structure).

starshapes.py

Generates antennas in starshape positions for groundplane or showerplane.

coordtransform.py

Has coordinate transformation functions. Do not touch unless you know what you are doing!

energy_fluence.py

Calculates energy fluence.

How to run

antenna_plotter.py

In order to run the antenna_plotter.py, You can either enter the path of the directory containing a single (!) antenna.list file: python antenna_plotter.py --dir <path_to_dir>

Or you can enter the full path to the .list file: python antenna_plotter.py --list <path_to_antenna.list> This is especially useful, when a directory contains more than one antenna.list file.

Additionally, you can specify the title of the resulting plots using the option --plotname or --name If not provided, the plot will be titled with "showerplane", "groundplane" or after the first antenna name in the file.

You can get a detailed description of the options by entering python antenna_plotter.py -h or python antenna_plotter.py --help

plot_traces.py

In order to run plot_traces.py, Specify the trace file: python plot_trace.py --path <path_to_trace.dat>

Additional optional parameters are: --plotname, which specifies the name of the plot and --out, which specifies the output directory of the created plot.

starshapes.py

Using ipython or another python script, call the function

create_stshp_list( zenith, azimuth, filename="antenna.list", obslevel=156400.0, # for Dunhuang, in cm for corsika obsplane = "sp", inclination=np.deg2rad(61.60523), # for Dunhuang Rmin=0., Rmax=500., n_rings=20, # for positions in starshape azimuths=np.deg2rad([0, 45, 90, 135, 180, 225, 270, 315]) # for positions in starshape )

Zenith and azimuth have to be specified, all other parameters are optional.

Zenith and azimuth have to be specified in degrees (!), they are converted to radians in the script.

Inclination has to be specified in radians (!), but np.deg2rad() is fine as input.