#!/usr/bin/env python
# -*- coding: utf-8 -*-.
# Full license can be found in License.md
# Full author list can be found in .zenodo.json file
# DOI:10.5281/zenodo.3986138
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Supports Cp index values.
Properties
----------
platform
'sw'
name
'cp'
tag
- 'def' Definitive Cp data from GFZ
- 'now' Nowcast Cp data from GFZ
inst_id
- ''
Note
----
Downloads data from ftp.gfz-potsdam.de (GFZ). These files also contain ap and Kp
data, and so the additional data files will be saved to the appropriate data
directories to avoid multiple downloads.
The historic definitive and nowcast Cp files are stored in yearly files, with
the current year being updated remotely on a regular basis. If you are using
historic data for the current year, we recommend re-downloading it before
performing your data processing.
Examples
--------
::
cp_ind = pysat.Instrument('sw', 'cp', tag='def')
cp_ind.download(start=dt.datetime(2010, 1, 1))
cp_ind.load(2010, 1)
"""
import datetime as dt
import functools
import numpy as np
import pysat
from pysatSpaceWeather.instruments import methods
# ----------------------------------------------------------------------------
# Instrument attributes
platform = 'sw'
name = 'cp'
tags = {'def': 'Definitive Cp data from GFZ',
'now': 'Nowcast Cp data from GFZ'}
inst_ids = {'': list(tags.keys())}
# ----------------------------------------------------------------------------
# Instrument test attributes
# Set test dates
_test_dates = {'': {'def': dt.datetime(2009, 1, 1),
'now': dt.datetime(2020, 1, 1)}}
# ----------------------------------------------------------------------------
# Instrument methods
preprocess = methods.general.preprocess
[docs]
def init(self):
"""Initialize the Instrument object with instrument specific values."""
self.acknowledgements = methods.kp_ap.acknowledgements(self.name, self.tag)
self.references = methods.kp_ap.references(self.name, self.tag)
pysat.logger.info(self.acknowledgements)
return
[docs]
def clean(self):
"""Clean the Kp, not required for this index (empty function)."""
return
# ----------------------------------------------------------------------------
# Instrument functions
download = functools.partial(methods.gfz.kp_ap_cp_download, platform, name)
list_files = functools.partial(methods.gfz.kp_ap_cp_list_files, name)
[docs]
def load(fnames, tag='', inst_id=''):
"""Load Cp index files.
Parameters
----------
fnames : pandas.Series
Series of filenames.
tag : str
Instrument tag. (default='')
inst_id : str
Instrument ID, not used. (default='')
Returns
-------
data : pandas.DataFrame
Object containing satellite data
meta : pysat.Meta
Object containing metadata such as column names and units
Note
----
Called by pysat. Not intended for direct use by user.
"""
# Load the definitive or nowcast data. The Cp data stored in yearly
# files, and we need to return data daily. The daily date is
# attached to filename. Parse off the last date, load month of data,
# and downselect to the desired day
data = methods.gfz.load_def_now(fnames)
# Initalize the meta data
meta = pysat.Meta()
methods.kp_ap.initialize_bartel_metadata(meta, 'Bartels_solar_rotation_num')
methods.kp_ap.initialize_bartel_metadata(meta,
'day_within_Bartels_rotation')
meta['Cp'] = {
meta.labels.units: '',
meta.labels.name: 'Cp index',
meta.labels.desc: ''.join(['the daily planetary character figure, ',
'a qualitative estimate of the overall ',
'level of geomagnetic activity for ',
'this day determined from the sum of ',
'the eight ap amplitudes']),
meta.labels.min_val: 0.0,
meta.labels.max_val: 2.5,
meta.labels.fill_val: np.nan}
meta['C9'] = {
meta.labels.units: '',
meta.labels.name: 'C9 index',
meta.labels.desc: ''.join(['the contracted scale for Cp']),
meta.labels.min_val: 0,
meta.labels.max_val: 9,
meta.labels.fill_val: -1}
return data, meta