Add ESD (3d ESA distributions)

pyspedas/themis/spacecraft/particles/esd.py

@@ -0,0 +1,78 @@
+# Hacked fro esa.py, for esd 3d L2 data files
+from pyspedas.themis.load import load
+
+
+def esd(trange=['2021-03-23', '2021-03-24'],
+        probe='a',
+        level='l2', #Kept here, but 'l2' is hardcoded in load.py
+        datatype = 'peif', #ESD datatypes are in separate files
+        suffix='',
+        get_support_data=False,
+        varformat=None,
+        varnames=[],
+        downloadonly=False,
+        notplot=False,
+        no_update=False,
+        time_clip=False):
+    """
+    This function loads Electrostatic Analyzer 3D  data distribution (ESD) data
+
+    Parameters:
+        trange : list of str
+            time range of interest [starttime, endtime] with the format
+            'YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day
+            ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss']
+
+        probe: str or list of str
+            Spacecraft probe letter(s) ('a', 'b', 'c', 'd' and/or 'e')
+
+        level: str
+            Data type; Valid options: 'l1', 'l2', NOT USED, 'l2' is hardcoded
+
+        datatype: 'peif', full-mode ion
+                  'peef', full-mode electron
+                  'peir', reduced mode ion
+                  'peer', reduced mode electron
+                  'peib', burst-mode ion
+                  'peir', burst-mode electron
+
+        suffix: str
+            The tplot variable names will be given this suffix.
+            By default, no suffix is added.
+
+        get_support_data: bool
+            Data with an attribute "VAR_TYPE" with a value of "support_data"
+            will be loaded into tplot.  By default, only loads in data with a
+            "VAR_TYPE" attribute of "data".
+
+        varformat: str
+            The file variable formats to load into tplot.  Wildcard character
+            "*" is accepted.  By default, all variables are loaded in.
+
+        varnames: list of str
+            List of variable names to load (if not specified,
+            all data variables are loaded)
+
+        downloadonly: bool
+            Set this flag to download the CDF files, but not load them into
+            tplot variables
+
+        notplot: bool
+            Return the data in hash tables instead of creating tplot variables
+
+        no_update: bool
+            If set, only load data from your local cache
+
+        time_clip: bool
+            Time clip the variables to exactly the range specified
+            in the trange keyword
+
+    Returns:
+        List of tplot variables created.
+
+    """
+    return load(instrument='esd', trange=trange, level=level, datatype=datatype,
+                suffix=suffix, get_support_data=get_support_data,
+                varformat=varformat, varnames=varnames,
+                downloadonly=downloadonly, notplot=notplot,
+                probe=probe, time_clip=time_clip, no_update=no_update)