# -*- coding: utf-8 -*-
"""Module for the ICON EUV instrument.
Supports the Extreme Ultraviolet (EUV) imager onboard the Ionospheric
CONnection Explorer (ICON) satellite. Accesses local data in
netCDF format.
Properties
----------
platform
'icon'
name
'euv'
tag
None supported
Warnings
--------
- The cleaning parameters for the instrument are still under development.
- Only supports level-2 data.
Examples
--------
::
import pysat
euv = pysat.Instrument(platform='icon', name='euv')
euv.download(dt.datetime(2020, 1, 1), dt.datetime(2020, 1, 31))
euv.load(2020, 1)
By default, pysat removes the ICON level tags from variable names, ie,
ICON_L27_Ion_Density becomes Ion_Density. To retain the original names, use
::
euv = pysat.Instrument(platform='icon', name='euv',
keep_original_names=True)
"""
import datetime as dt
import functools
import pysat
from pysat.instruments.methods import general as mm_gen
from pysat import logger
from pysatNASA.instruments.methods import cdaweb as cdw
from pysatNASA.instruments.methods import icon as mm_icon
# ----------------------------------------------------------------------------
# Instrument attributes
platform = 'icon'
name = 'euv'
tags = {'': 'Level 2 public geophysical data'}
inst_ids = {'': ['']}
pandas_format = False
# ----------------------------------------------------------------------------
# Instrument test attributes
_test_dates = {'': {'': dt.datetime(2020, 1, 1)}}
# ----------------------------------------------------------------------------
# Instrument methods
[docs]def init(self):
"""Initialize the Instrument object with instrument specific values.
Runs once upon instantiation.
Parameters
-----------
inst : pysat.Instrument
Instrument class object
"""
logger.info(mm_icon.ackn_str)
self.acknowledgements = mm_icon.ackn_str
self.references = ''.join((mm_icon.refs['mission'],
mm_icon.refs['euv']))
return
[docs]def preprocess(self, keep_original_names=False):
"""Adjust epoch timestamps to datetimes and remove variable preambles.
Parameters
----------
keep_original_names : boolean
if True then the names as given in the netCDF ICON file
will be used as is. If False, a preamble is removed. (default=False)
"""
mm_gen.convert_timestamp_to_datetime(self, sec_mult=1.0e-3)
if not keep_original_names:
mm_gen.remove_leading_text(self, target='ICON_L26_')
return
[docs]def clean(self):
"""Clean ICON EUV data to the specified level.
Note
----
Supports 'clean', 'dusty', 'dirty', 'none'. Method is
not called by pysat if clean_level is None or 'none'.
"""
vars = ['HmF2', 'NmF2', 'Oplus']
if 'Flag' in self.variables:
icon_flag = 'Flag'
else:
icon_flag = 'ICON_L26_Flag'
vars = ['ICON_L26_' + x for x in vars]
max_val = {'clean': 1.0, 'dusty': 2.0}
if self.clean_level in ['clean', 'dusty']:
for var in vars:
self[var] = self[var].where(self[icon_flag]
<= max_val[self.clean_level])
return
# ----------------------------------------------------------------------------
# Instrument functions
#
# Use the ICON and pysat methods
# Set the list_files routine
fname = ''.join(('icon_l2-6_euv_{year:04d}{month:02d}{day:02d}_',
'v{version:02d}r{revision:03d}.nc'))
supported_tags = {'': {'': fname}}
list_files = functools.partial(mm_gen.list_files,
supported_tags=supported_tags)
# Set the download routine
basic_tag = {'remote_dir': '/pub/data/icon/l2/l2-6_euv/{year:04d}/',
'fname': fname}
download_tags = {'': {'': basic_tag}}
download = functools.partial(cdw.download, supported_tags=download_tags)
# Set the list_remote_files routine
list_remote_files = functools.partial(cdw.list_remote_files,
supported_tags=download_tags)
[docs]def load(fnames, tag=None, inst_id=None, keep_original_names=False):
"""Load ICON EUV data into `xarray.Dataset` object and `pysat.Meta` objects.
This routine is called as needed by pysat. It is not intended
for direct user interaction.
Parameters
----------
fnames : array-like
Iterable of filename strings, full path, to data files to be loaded.
This input is nominally provided by pysat itself.
tag : string
Tag name used to identify particular data set to be loaded.
This input is nominally provided by pysat itself. (default=None)
inst_id : string
Satellite ID used to identify particular data set to be loaded.
This input is nominally provided by pysat itself. (default=None)
keep_original_names : boolean
If True then the names as given in the netCDF ICON file
will be used as is. If False, a preamble is removed. (default=False)
Returns
-------
data : xr.Dataset
An xarray Dataset with data prepared for the pysat.Instrument
meta : pysat.Meta
Metadata formatted for a pysat.Instrument object.
Note
----
Any additional keyword arguments passed to pysat.Instrument
upon instantiation are passed along to this routine.
The 'Altitude' dimension is renamed as 'Alt' to avoid confusion with the
'Altitude' variable when performing xarray operations
Examples
--------
::
inst = pysat.Instrument('icon', 'euv', tag='', inst_id='a')
inst.load(2020, 1)
"""
labels = {'units': ('Units', str), 'name': ('Long_Name', str),
'notes': ('Var_Notes', str), 'desc': ('CatDesc', str),
'min_val': ('ValidMin', float),
'max_val': ('ValidMax', float), 'fill_val': ('FillVal', float)}
data, meta = pysat.utils.load_netcdf4(fnames, epoch_name='Epoch',
pandas_format=pandas_format,
labels=labels)
# xarray can't merge if variable and dim names are the same
if 'Altitude' in data.dims:
data = data.rename_dims(dims_dict={'Altitude': 'Alt'})
return data, meta