Skip to content

Commit

Permalink
DOC: update file headers
Browse files Browse the repository at this point in the history
Update the code file headers to include the NRL pub release.
  • Loading branch information
aburrell committed Jan 31, 2024
1 parent 228af42 commit 0db87d1
Show file tree
Hide file tree
Showing 19 changed files with 87 additions and 15 deletions.
7 changes: 4 additions & 3 deletions pysatMadrigal/instruments/dmsp_ivm.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-
"""Supports the Defense Meteorological Satellite Program (DMSP) IVM instruments.
The Ion Velocity Meter (IVM) is comprised of the Retarding Potential Analyzer
Expand Down Expand Up @@ -45,8 +48,6 @@
----
Please provide name and email when downloading data with this routine.
Code development supported by NSF grant 1259508
"""

import datetime as dt
Expand Down
5 changes: 4 additions & 1 deletion pysatMadrigal/instruments/dmsp_ssj.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-
"""Support the DMSP Special Sensor-J (SSJ) instrument and derived products.
The Defense Meteorological Satellite Program (DMSP) SSJ measures precipitating
Expand Down
10 changes: 9 additions & 1 deletion pysatMadrigal/instruments/gnss_tec.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# -*- coding: utf-8 -*-.
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Supports the MIT Haystack GNSS TEC data products.
The Global Navigation Satellite System (GNSS) is used in conjunction with a
Expand Down
5 changes: 4 additions & 1 deletion pysatMadrigal/instruments/jro_isr.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-.
"""Supports the Incoherent Scatter Radar at the Jicamarca Radio Observatory.
Properties
Expand Down
5 changes: 4 additions & 1 deletion pysatMadrigal/instruments/madrigal_dst.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-.
"""Supports access to Dst data archieved at Madrigal.
Properties
Expand Down
5 changes: 4 additions & 1 deletion pysatMadrigal/instruments/madrigal_geoind.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-.
"""Supports access to F10.7, Kp, and Ap data archieved at Madrigal.
Properties
Expand Down
5 changes: 4 additions & 1 deletion pysatMadrigal/instruments/methods/dmsp.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-
"""Methods supporting the Defense Meteorological Satellite Program (DMSP)."""

import numpy as np
Expand Down
5 changes: 4 additions & 1 deletion pysatMadrigal/instruments/methods/general.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-.
"""General routines for integrating CEDAR Madrigal instruments into pysat."""

import datetime as dt
Expand Down
5 changes: 4 additions & 1 deletion pysatMadrigal/instruments/methods/gnss.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-
"""Methods supporting the Global Navigation Satellite System platform."""

import datetime as dt
Expand Down
5 changes: 4 additions & 1 deletion pysatMadrigal/instruments/methods/jro.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-
"""Methods supporting the Jicamarca Radio Observatory (JRO) platform."""

import numpy as np
Expand Down
5 changes: 4 additions & 1 deletion pysatMadrigal/instruments/ngdc_ae.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-.
"""Supports access to taped data of AE from the World Data Center A (Boulder).
Properties
Expand Down
5 changes: 4 additions & 1 deletion pysatMadrigal/instruments/omni2_imf.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
# -*- coding: utf-8 -*-.
"""Supports access to OMNI 2 IMF data archieved at Madrigal.
Properties
Expand Down
4 changes: 4 additions & 0 deletions pysatMadrigal/tests/test_instruments.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Unit tests for the Instruments."""

Expand Down
6 changes: 5 additions & 1 deletion pysatMadrigal/tests/test_methods_dmsp.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Test methods for `pysatMadrigal.instruments.methods.gnss`."""
"""Test methods for `pysatMadrigal.instruments.methods.dmsp`."""

import logging
import numpy as np
Expand Down
4 changes: 4 additions & 0 deletions pysatMadrigal/tests/test_methods_general.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Unit tests for the general instrument methods."""

Expand Down
4 changes: 4 additions & 0 deletions pysatMadrigal/tests/test_methods_gnss.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Test methods for `pysatMadrigal.instruments.methods.gnss`."""

Expand Down
4 changes: 4 additions & 0 deletions pysatMadrigal/tests/test_methods_jro.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Test methods for `pysatMadrigal.instruments.methods.jro`."""

Expand Down
9 changes: 9 additions & 0 deletions pysatMadrigal/tests/test_utils_coords.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Tests for the coordinate conversion functions."""
import numpy as np

Expand Down
4 changes: 4 additions & 0 deletions pysatMadrigal/utils/coords.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
#!/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.3824979
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Coordinate transformation functions."""

Expand Down

0 comments on commit 0db87d1

Please sign in to comment.