Skip to content

Commit

Permalink
Merge pull request #585 from spedas/elfin-epd-calibration
Browse files Browse the repository at this point in the history
Elfin epd calibration
  • Loading branch information
jiashuwu89 authored Sep 7, 2023
2 parents 24fb3fa + f16861b commit 31e59bc
Show file tree
Hide file tree
Showing 12 changed files with 1,471 additions and 96 deletions.
88 changes: 6 additions & 82 deletions pyspedas/elfin/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
from functools import wraps

from .load import load
from .epd.epd import elfin_load_epd

@wraps(elfin_load_epd)
def epd(*args, **kwargs):
return elfin_load_epd(*args, **kwargs)

def fgm(trange=['2020-10-01', '2020-10-02'],
probe='a',
Expand Down Expand Up @@ -86,90 +92,8 @@ def fgm_postprocessing(variables):
return variables


def epd(trange=['2020-11-01', '2020-11-02'],
probe='a',
datatype='pef',
level='l1',
suffix='',
get_support_data=False,
varformat=None,
varnames=[],
downloadonly=False,
notplot=False,
no_update=False,
time_clip=False):
"""
This function loads data from the Energetic Particle Detector (EPD)
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
Spacecraft identifier ('a' or 'b')
datatype: str
Data type; Valid options:
'pef' for L1 data
'pif' for L1 data
'pes' for L1 data
'pis' for L1 data
level: str
Data level; options: 'l1' (default: l1)
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.
"""
tvars = load(instrument='epd', probe=probe, trange=trange, level=level, datatype=datatype, suffix=suffix, get_support_data=get_support_data, varformat=varformat, varnames=varnames, downloadonly=downloadonly, notplot=notplot, time_clip=time_clip, no_update=no_update)

if tvars is None or notplot or downloadonly:
return tvars

return epd_postprocessing(tvars)


def epd_postprocessing(variables):
"""
Placeholder for EPD post-processing
"""
return variables


def mrma(trange=['2020-11-5', '2020-11-6'],
probe='a',
Expand Down
Loading

0 comments on commit 31e59bc

Please sign in to comment.