IORG is a python module for calculating the Organization Index (Tompkins and Semie, 2017) as used in RCEMIP (Wing et al., 2020).
The main function, calc_iorg(w_f,geometry,threshold=0,tbeg=-999,tend=-999), takes two mandatory arguments and has three optional arguments.
w_f: a 3-D (time,y,x) array containing the convection datageometry: a string determining which Iorg calculation to use which is geometry-dependentthreshold (default=0): is an integer determining which convection variable is being used - 0 for olr, 1 for vertical velocitytbeg (default=-999): integer determining the time index to start at, default is -999 which will use 25 days from the end of the datatend (default=-999): integer determining the time index to end at, default is -999 which will go to the end of the time arrayimport IORG
# calculate Iorg starting from hour 1800 and ending at hour 2000 for a CRM using OLR
iorg = IORG.calc_iorg(olr,'cartesian',threshold=0,tbeg=1800,tend=2000)
# calculate Iorg starting from hour 1800 for a GCM using vertical velocity
iorg = IORG.calc_iorg(omega,'spherical',threshold=1,tbeg=1800)