Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

STY: use standard init routines #202

Merged
merged 4 commits into from
Sep 8, 2023
Merged

STY: use standard init routines #202

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9f69e5
STY: use standard init
jklenzing Sep 7, 2023
9caf8b9
DOC: update changelog
jklenzing Sep 7, 2023
8446dea
STY: pep8
jklenzing Sep 7, 2023
a45328a
Apply suggestions from code review
jklenzing Sep 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
* Maintenance
* Implemented unit tests for cleaning warnings
* Use pip install for readthedocs
* Move references and acknowledgements to methods files
jklenzing marked this conversation as resolved.
Show resolved Hide resolved

## [0.0.5] - 2023-06-27
* New Instruments
Expand Down
28 changes: 2 additions & 26 deletions pysatNASA/instruments/formosat1_ivm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
import functools

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 formosat as mm_formosat
from pysatNASA.instruments.methods import general as mm_nasa

# ----------------------------------------------------------------------------
Expand All @@ -47,31 +47,7 @@
# ----------------------------------------------------------------------------
# Instrument methods


def init(self):
"""Initialize the Instrument object with instrument specific values.
Runs once upon instantiation.
"""
self.acknowledgements = ' '.join(('Data provided through NASA CDAWeb',
'Key Parameters - Shin-Yi Su',
'(Institute of Space Science,',
'National Central University,',
'Taiwan, R.O.C.)'))
self.references = ' '.join(('Yeh, H.C., S.‐Y. Su, Y.C. Yeh, J.M. Wu,',
'R. A. Heelis, and B. J. Holt, Scientific',
'mission of the IPEI payload on board',
'ROCSAT‐1, Terr. Atmos. Ocean. Sci., 9,',
'suppl., 1999a.\n',
'Yeh, H.C., S.‐Y. Su, R.A. Heelis, and',
'J.M. Wu, The ROCSAT‐1 IPEI preliminary',
'results, Vertical ion drift statistics,',
'Terr. Atmos. Ocean. Sci., 10, 805,',
'1999b.'))
logger.info(self.acknowledgements)

return
init = functools.partial(mm_nasa.init, module=mm_formosat, name=name)


# Use default clean
Expand Down
31 changes: 2 additions & 29 deletions pysatNASA/instruments/iss_fpmu.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
import functools

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 general as mm_nasa
from pysatNASA.instruments.methods import iss as mm_iss

# ----------------------------------------------------------------------------
# Instrument attributes
Expand All @@ -49,34 +49,7 @@
# ----------------------------------------------------------------------------
# Instrument methods


def init(self):
"""Initialize the Instrument object with instrument specific values.
Runs once upon instantiation.
"""

ackn_str = ' '.join(('Data provided through NASA CDAWeb. Contact',
'[email protected] for support and use.'))
logger.info(ackn_str)
self.acknowledgements = ackn_str
self.references = ' '.join(('V. N. Coffey et al., "Validation of the',
'Plasma Densities and Temperatures From',
'the ISS Floating Potential Measurement',
'Unit," in IEEE Transactions on Plasma',
'Science, vol. 36, no. 5, pp. 2301-2308,',
'Oct. 2008,',
'doi: 10.1109/TPS.2008.2004271.\n',
'A. Barjatya, C.M. Swenson, D.C.',
'Thompson, and K.H. Wright Jr., Data',
'analysis of the Floating Potential',
'Measurement Unit aboard the',
'International Space Station, Rev. Sci.',
'Instrum. 80, 041301 (2009),',
'https://doi.org/10.1063/1.3116085'))

return
init = functools.partial(mm_nasa.init, module=mm_iss, name=name)


# Use default clean
Expand Down
2 changes: 2 additions & 0 deletions pysatNASA/instruments/methods/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@
from pysatNASA.instruments.methods import cnofs # noqa F401
from pysatNASA.instruments.methods import de2 # noqa F401
from pysatNASA.instruments.methods import dmsp # noqa F401
from pysatNASA.instruments.methods import formosat # noqa F401
from pysatNASA.instruments.methods import general # noqa F401
from pysatNASA.instruments.methods import gps # noqa F401
from pysatNASA.instruments.methods import icon # noqa F401
from pysatNASA.instruments.methods import iss # noqa F401
from pysatNASA.instruments.methods import jhuapl # noqa F401
from pysatNASA.instruments.methods import omni # noqa F401
from pysatNASA.instruments.methods import ses14 # noqa F401
Expand Down
14 changes: 14 additions & 0 deletions pysatNASA/instruments/methods/formosat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# -*- coding: utf-8 -*-
"""Provides non-instrument specific routines for C/NOFS data."""

ackn_str = ' '.join(('Data provided through NASA CDAWeb Key Parameters -',
'Shin-Yi Su (Institute of Space Science, National Central',
'University, Taiwan, R.O.C.)'))
refs = {'ivm': ' '.join(('Yeh, H.C., S.‐Y. Su, Y.C. Yeh, J.M. Wu, R. A.',
'Heelis, and B. J. Holt, Scientific mission of the',
'IPEI payload on board ROCSAT‐1, Terr. Atmos. Ocean.',
'Sci., 9, suppl., 1999a.\n',
'Yeh, H.C., S.‐Y. Su, R.A. Heelis, and J.M. Wu, The',
'ROCSAT‐1 IPEI preliminary results, Vertical ion',
'drift statistics, Terr. Atmos. Ocean. Sci., 10, 805,',
'1999b.'))}
29 changes: 29 additions & 0 deletions pysatNASA/instruments/methods/iss.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# -*- coding: utf-8 -*-
"""Provides non-instrument specific routines for C/NOFS data."""

ackn_str = ' '.join(("R.M. Suggs, S.L. Koontz, NASA Johnson Space Center",
"Contact Rob Suggs for support and use.",
"[email protected]. Please acknowledge the data",
"providers and CDAWeb when using these data."))

refs = {'fpmu': ' '.join(('V. N. Coffey et al., "Validation of the Plasma',
'Densities and Temperatures From the ISS Floating',
'Potential Measurement Unit," in IEEE Transactions',
'on Plasma Science, vol. 36, no. 5, pp. 2301-2308,',
'Oct. 2008, doi: 10.1109/TPS.2008.2004271.',
'\n',
'A. Barjatya, C.M. Swenson, D.C. Thompson, and K.H.',
'Wright Jr., Data analysis of the Floating Potential',
'Measurement Unit aboard the International Space',
'Station, Rev. Sci. Instrum. 80, 041301 (2009),',
'https://doi.org/10.1063/1.3116085',
'\n',
'Debchoudhury, S., Barjatya, A., Minow, J. I.,',
'Coffey, V. N., & Chandler, M. O. (2021).',
'Observations and validation of plasma density,',
'temperature, and O+ abundance from a Langmuir',
'probe onboard the International Space Station.',
'Journal of Geophysical Research: Space',
'Physics, 126, e2021JA029393.',
'https://doi.org/10.1029/2021JA029393'))
}
11 changes: 11 additions & 0 deletions pysatNASA/instruments/methods/omni.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@
import pysat


ackn_str = ' '.join(('For full acknowledgement info, please see:',
'https://omniweb.gsfc.nasa.gov/html/citing.html'))

refs = {'hro': ' '.join(('J.H. King and N.E. Papitashvili, Solar',
'wind spatial scales in and comparisons',
'of hourly Wind and ACE plasma and',
'magnetic field data, J. Geophys. Res.,',
'Vol. 110, No. A2, A02209,',
'10.1029/2004JA010649.'))}


def time_shift_to_magnetic_poles(inst):
"""Shift OMNI times to intersection with the magnetic pole.

Expand Down
22 changes: 2 additions & 20 deletions pysatNASA/instruments/omni_hro.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@
import pandas as pds
import warnings

import pysat
from pysat.instruments.methods import general as mm_gen

from pysatNASA.instruments.methods import cdaweb as cdw
from pysatNASA.instruments.methods import general as mm_nasa
from pysatNASA.instruments.methods import omni as mm_omni

# ----------------------------------------------------------------------------
Expand All @@ -68,25 +68,7 @@
# ----------------------------------------------------------------------------
# Instrument methods


def init(self):
"""Initialize the Instrument object with instrument specific values.
Runs once upon instantiation.
"""

ackn_str = ''.join(('For full acknowledgement info, please see: ',
'https://omniweb.gsfc.nasa.gov/html/citing.html'))
self.acknowledgements = ackn_str
self.references = ' '.join(('J.H. King and N.E. Papitashvili, Solar',
'wind spatial scales in and comparisons',
'of hourly Wind and ACE plasma and',
'magnetic field data, J. Geophys. Res.,',
'Vol. 110, No. A2, A02209,',
'10.1029/2004JA010649.'))
pysat.logger.info(ackn_str)
return
init = functools.partial(mm_nasa.init, module=mm_omni, name=name)


def clean(self):
Expand Down
Loading