Merge pull request #103 from pysat/rc_v0.0.8

Release Candidate v0.0.8

Author: aburrell

.github/workflows/docs.yml

@@ -16,9 +16,9 @@ jobs:
 
     name:
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 

.github/workflows/main.yml

@@ -16,15 +16,15 @@ jobs:
         numpy_ver: [latest]
         include:
           - python-version: "3.8"
-            numpy_ver: "1.19"
+            numpy_ver: "1.20.3"
             os: ubuntu-latest
 
     name: Python ${{ matrix.python-version }} on ${{ matrix.os }} with numpy ${{ matrix.numpy_ver }}
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -37,7 +37,7 @@ jobs:
     - name: Install NEP29 dependencies
       if: ${{ matrix.numpy_ver != 'latest'}}
       run: |
-        pip install --no-binary :numpy: numpy==${{ matrix.numpy_ver }}
+        pip install numpy==${{ matrix.numpy_ver }}
 
     - name: Set up pysat
       run: |

.github/workflows/pysat_rc.yml

@@ -0,0 +1,44 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Test with latest pysat RC
+
+on: [workflow_dispatch]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10"]
+
+    name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install pysat RC
+      run: pip install --no-deps -i https://test.pypi.org/simple/ pysat
+
+    - name: Install standard dependencies
+      run: |
+        pip install -r requirements.txt
+        pip install -r test_requirements.txt
+
+    - name: Set up pysat
+      run: |
+        mkdir pysatData
+        python -c "import pysat; pysat.params['data_dirs'] = 'pysatData'"
+
+    - name: Test with pytest
+      run: pytest -vs --cov=pysatSpaceWeather/
+
+    - name: Publish results to coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: coveralls --rcfile=setup.cfg --service=github

CHANGELOG.md

@@ -3,10 +3,28 @@ Change Log
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
+[0.0.8] - 2022-11-29
+--------------------
+* Bugs
+   * Fixed F10.7 prelim and daily metadata to allow the fill value to keep the
+     same type as the data
+* Maintenance
+  * Updated the GitHub action version numbers
+  * Updated syntax for pysat instrument testing suite
+  * Remove deprecated pytest syntax (backwards support for nose)
+  * Removed deprecated pandas syntax (iteritems)
+  * Added Github action workflow using the latest pysat RC
+  * Added new tags for the sw_kp instrument's GFZ data, 'def' and 'now', to
+    replace ''
+
 [0.0.7] - 2022-09-15
 --------------------
 * Updated `sw_f107` to allow reading old and new `historic` data file format
 * Added exampled to the documentation for F10.7 and Kp methods
+* Captured JSON error in historic F10.7 downloads and wrapped it with a logger
+  message informing the user that their date may not be in the database
+* Removed warning for not using the deprecated `freq` kwarg
+* Removed deprecated function `load_csv_data`
 
 [0.0.6] - 2022-07-08
 --------------------

docs/conf.py

@@ -59,9 +59,9 @@
 project = 'pysatSpaceWeather'
 title = '{:s} Documentation'.format(project)
 zenodo = json.loads(open('../.zenodo.json').read())
-author = ', '.join([x['name'] for x in zenodo['creators']])
+author = ', '.join([auth['name'] for auth in zenodo['creators']])
 description = 'Tools for space weather indices.'
-copyright = ', '.join(['2021', author])
+copyright = ', '.join(['2022', author])
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/examples/ex_f107.rst

@@ -27,8 +27,7 @@ This may be done using the
                                 tag='45day', update_files=True)
 
    # If needed, download the data
-   f107_hist.download(start=f107_hist.lasp_stime, stop=dt.datetime(2018, 4, 1),
-                      freq='MS')
+   f107_hist.download(start=f107_hist.lasp_stime, stop=dt.datetime(2018, 4, 1))
    f107_prel.download(start=f107_hist.files.files.index[-1],
                       stop=f107_prel.today())
    f107_fore.download(start=f107_fore.today())

docs/examples/ex_init.rst

@@ -18,9 +18,9 @@ used as an example.
 
    f107 = pysat.Instrument(inst_module=py_sw.instruments.sw_f107,
                            tag='historic', update_files=True)
-   f107.download(start=f107.lasp_stime, stop=f107.today(), freq='MS')
+   f107.download(start=f107.lasp_stime, stop=f107.today())
    f107.load()
-   print(f107)
+   print(f107.data)
 
 
 The output includes all available historic data (as implied by the tag name),
@@ -32,18 +32,18 @@ output shown below (the index header has been added here for clarity).
 ::
 
 
-   <Index>     f107
-   1947-02-14  253.9
-   1947-02-17  228.5
-   1947-02-19  178.8
-   1947-02-20  163.7
-   1947-02-24  164.1
-   ...           ...
-   2018-04-27   69.6
-   2018-04-28   71.1
-   2018-04-29   72.2
-   2018-04-30   71.3
+   <Index>     f107  f107_adjusted  f107_observed
+   1947-02-14  253.9          253.9            NaN
+   1947-02-17  228.5          228.5            NaN
+   1947-02-19  178.8          178.8            NaN
+   1947-02-20  163.7          163.7            NaN
+   1947-02-24  164.1          164.1            NaN
+   ...           ...            ...            ...
+   2018-04-27   69.6           69.6           68.7
+   2018-04-28   71.1           71.1           70.2
+   2018-04-29   72.2           72.2           71.1
+   2018-04-30   71.3           71.3           70.2
    
-   [25367 rows x 1 columns]
+   [25367 rows x 3 columns]
 
 

docs/examples/ex_kp.rst

@@ -19,7 +19,7 @@ different time periods. This may be done using the
    import pysatSpaceWeather as py_sw
 
    kp_his = pysat.Instrument(inst_module=py_sw.instruments.sw_kp,
-                             tag='', update_files=True)
+                             tag='def', update_files=True)
    kp_rec = pysat.Instrument(inst_module=py_sw.instruments.sw_kp,
                              tag='recent', update_files=True)
    kp_for = pysat.Instrument(inst_module=py_sw.instruments.sw_kp,
@@ -91,7 +91,7 @@ converts Kp to ap, as shown below.
    
    py_sw.instruments.methods.kp_ap.convert_3hr_kp_to_ap(kp)
 
-   print("Max: {:.1f} -> {:d}, Min: {:.1f} -> {:d}".format(
+   print("Max: {:.1f} -> {:.1f}, Min: {:.1f} -> {:.1f}".format(
        kp['Kp'].max(), kp['3hr_ap'].max(), kp['Kp'].min(), kp['3hr_ap'].min()))
 
 This yields ``Max: 9.0 -> 400.0, Min: 0.0 -> 0.0``. 

pysatSpaceWeather/instruments/methods/ace.py

@@ -11,7 +11,6 @@
 import os
 import pandas as pds
 import requests
-import warnings
 
 import pysat
 
@@ -300,54 +299,6 @@ def common_metadata():
     return meta, status_desc
 
 
-def load_csv_data(fnames, read_csv_kwargs=None):
-    """Load CSV data from a list of files into a single DataFrame.
-
-    .. deprecated:: 0.0.5
-        `load_csv_data` will be removed in pysatSpaceWeather 0.0.6+, as it has
-        been moved to `pysat.instruments.methods.general` as of pysat 3.0.1.
-
-    Parameters
-    ----------
-    fnames : array-like
-        Series, list, or array of filenames
-    read_csv_kwargs : dict or NoneType
-        Dict of kwargs to apply to `pds.read_csv`. (default=None)
-
-    Returns
-    -------
-    data : pds.DataFrame
-        Data frame with data from all files in the fnames list
-
-    See Also
-    --------
-    pds.read_csv, pysat.instruments.methods.general.load_csv_data
-
-    """
-
-    warnings.warn("".join(["Moved to pysat.instruments.methods.general.",
-                           "load_csv_data in pysat version 3.0.1. This method ",
-                           "will be removed at the 0.0.6+ release."]),
-                  DeprecationWarning)
-
-    # Ensure the filename input is array-like
-    fnames = np.asarray(fnames)
-    if fnames.shape == ():
-        fnames = np.asarray([fnames])
-
-    # Initialize the optional kwargs
-    if read_csv_kwargs is None:
-        read_csv_kwargs = {}
-
-    # Create a list of data frames from each file
-    fdata = []
-    for fname in fnames:
-        fdata.append(pds.read_csv(fname, **read_csv_kwargs))
-
-    data = pds.DataFrame() if len(fdata) == 0 else pds.concat(fdata, axis=0)
-    return data
-
-
 def ace_swepam_hourly_omni_norm(as_inst, speed_key='sw_bulk_speed',
                                 dens_key='sw_proton_dens',
                                 temp_key='sw_ion_temp'):

pysatSpaceWeather/instruments/methods/f107.py

@@ -145,7 +145,7 @@ def combine_f107(standard_inst, forecast_inst, start=None, stop=None):
     f107_inst.inst_module = pysat_sw.instruments.sw_f107
     f107_inst.tag = tag
     f107_inst.date = start
-    f107_inst.doy = int(start.strftime("%j"))
+    f107_inst.doy = np.int64(start.strftime("%j"))
     fill_val = None
 
     f107_times = list()
@@ -326,7 +326,7 @@ def parse_45day_block(block_lines):
                       for tt in split_line[::2]])
 
         # Format the data values
-        values.extend([int(vv) for vv in split_line[1::2]])
+        values.extend([np.int64(vv) for vv in split_line[1::2]])
 
     return dates, values
 
@@ -428,7 +428,7 @@ def parse_daily_solar_data(data_lines, year, optical):
                 if val == "*":
                     val = -999 if i < 5 else -1
                 else:
-                    val = int(val)
+                    val = np.int64(val)
             values[kk].append(val)
 
     return dates, values