Add documentation and better error reporting

.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: Documentation
+
+on:
+    push:
+        paths:
+            - "docs/**"
+            - "AUTHORS.rst"
+            - "CHANGES.rst"
+            - "CONTRIBUTING.rst"
+            - "LICENSE.rst"
+            - "README.rst"
+    pull_request:
+        paths:
+            - "docs/**"
+            - "AUTHORS.rst"
+            - "CHANGES.rst"
+            - "CONTRIBUTING.rst"
+            - "LICENSE.rst"
+            - "README.rst"
+
+jobs:
+    build:
+        # We want to run on external PRs, but not on our own internal PRs as they'll be run
+        # by the push to the branch. Without this if check, checks are duplicated since
+        # internal PRs match both the push and pull_request events.
+        if:
+          github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
+          github.repository
+
+        runs-on: ubuntu-latest
+
+        defaults:
+          run:
+            shell: bash -l {0}
+
+        steps:
+          - uses: actions/checkout@v2
+          - uses: conda-incubator/setup-miniconda@v2
+            with:
+              auto-update-conda: true
+              python-version: 3.9
+              channels: conda-forge
+              channel-priority: true
+
+          - name: Show conda installation info
+            run: conda info
+
+          - name: Install dependencies
+            run: |
+              pip install -e ".[doc]"
+
+          - name: Build documentation
+            run: make -C docs clean html            

AUTHORS.rst

@@ -0,0 +1,12 @@
+Credits
+=======
+
+Development Lead
+----------------
+
+* Eric Hutton (@mcflugen)
+
+Contributors
+------------
+
+None yet. Why not be the first?

CHANGES.rst

@@ -0,0 +1,4 @@
+Release Notes
+=============
+
+.. towncrier release notes start

README.rst

@@ -1,2 +1,156 @@
-# bmi-wavewatch3
-Fetch WaveWatch3 data
+wavewatch3: Python interface to WAVEWATCH III
+=============================================
+
+.. image:: https://github.com/csdms/bmi-wavewatch3/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/csdms/bmi-wavewatch3/actions/workflows/test.yml
+   :alt: Test status
+
+.. image:: https://github.com/csdms/bmi-wavewatch3/workflows/Flake8/badge.svg
+
+.. image:: https://github.com/csdms/bmi-wavewatch3/workflows/Black/badge.svg
+
+
+About
+-----
+
+The *wavewatch3* Python package provides both a command line interface and a programming interface
+for downloading and working with `WAVEWATCH III`_ data.
+
+*wavewatch3* provides access to the following raster data sources,
+
+* 30 year wave hindcast `Phase 1`_
+* 30 year wave hindcast `Phase 2`_
+* Production hindcast Singlegrid_
+* Production hindcast Multigrid_
+
+All data sources provide both global and regional grids.
+
+Installation
+------------
+
+*wavewatch3* can be installed by running ``pip install wavewatch3``. It requires Python >= 3.8 to run.
+
+If you simply can't wait for the latest release, you can install *wavewatch3*
+directly from GitHub,
+
+.. code-block:: bash
+
+   $ pip install git+https://github.com/csdms/bmi-wavewatch3
+
+*wavewatch3* is also available through *conda*, ``conda install wavewatch3 -c conda-forge``.
+
+
+Usage
+-----
+
+To get started, you can download *WAVEWATCH III* data by date with the *ww3* command
+(use `ww3 --help` to print a brief message),
+
+.. code-block:: bash
+
+    $ ww3 fetch "2010-05-22"
+
+You can also do this through Python,
+
+.. code-block:: python
+
+    >>> from wavewatch3 import WaveWatch3
+    >>> WaveWatch3.fetch("2010-05-22")
+
+The *wavewatch3* package provides the ``WaveWatch3`` class for downloading data and
+presenting it as an *xarray* *Dataset*.
+
+.. code-block:: python
+
+   >>> from wavewatch3 import WaveWatch3
+   >>> ww3 = WaveWatch3("2010-05-22")
+   >>> ww3.data
+   <xarray.Dataset>
+   ...
+
+Use the ``inc`` method to advance in time month-by-month,
+
+.. code-block:: python
+
+   >>> ww3.date
+   '2010-05-22'
+   >>> ww3.inc()
+   '2010-06-22'
+   >>> ww3.data.time
+   <xarray.DataArray 'time' ()>
+   array('2010-06-01T00:00:00.000000000', dtype='datetime64[ns]')
+   ...
+
+This will download new datasets as necessary and load the new data into the ``data`` attribute.
+
+.. note::
+
+   If the new data are not cached on you computer, you will notice a delay while the new
+   data are download. If the ``lazy`` flag is set, the download will only occur once you
+   try to access the data (i.e. ``ww3.data``), otherwise the data are downloaded
+   as soon as the date is set.
+
+Example
+-------
+
+
+.. code:: python
+
+   >>> from wavewatch3 import WaveWatch3
+   >>> ww3 = WaveWatch3("2009-11-08")
+
+The data can be accessed as an *xarray* *Dataset* through the ``data`` attribute.
+
+.. code:: python
+
+   >>> ww3.data
+   <xarray.Dataset>
+   Dimensions:     (step: 241, latitude: 311, longitude: 720)
+   Coordinates:
+       time        datetime64[ns] 2009-11-01
+     * step        (step) timedelta64[ns] 0 days 00:00:00 ... 30 days 00:00:00
+       surface     float64 1.0
+     * latitude    (latitude) float64 77.5 77.0 76.5 76.0 ... -76.5 -77.0 -77.5
+     * longitude   (longitude) float64 0.0 0.5 1.0 1.5 ... 358.0 358.5 359.0 359.5
+       valid_time  (step) datetime64[ns] dask.array<chunksize=(241,), meta=np.ndarray>
+   Data variables:
+       dirpw       (step, latitude, longitude) float32 dask.array<chunksize=(241, 311, 720), meta=np.ndarray>
+       perpw       (step, latitude, longitude) float32 dask.array<chunksize=(241, 311, 720), meta=np.ndarray>
+       swh         (step, latitude, longitude) float32 dask.array<chunksize=(241, 311, 720), meta=np.ndarray>
+       u           (step, latitude, longitude) float32 dask.array<chunksize=(241, 311, 720), meta=np.ndarray>
+       v           (step, latitude, longitude) float32 dask.array<chunksize=(241, 311, 720), meta=np.ndarray>
+   Attributes:
+       GRIB_edition:            2
+       GRIB_centre:             kwbc
+       GRIB_centreDescription:  US National Weather Service - NCEP
+       GRIB_subCentre:          0
+       Conventions:             CF-1.7
+       institution:             US National Weather Service - NCEP
+       history:                 2022-06-08T16:08 GRIB to CDM+CF via cfgrib-0.9.1...
+
+The ``step`` attribute points to the current time slice into the data (i.e number of three hour increments
+since the start of the month),
+
+.. code:: python
+
+   >>> ww3.step
+   56
+   >>> ww3.data.swh[ww3.step, :, :].plot()
+
+.. image:: https://raw.githubusercontent.com/csdms/bmi-wavewatch3/main/docs/source/_static/ww3_global_swh.png
+  :width: 100%
+  :alt: Significant wave height
+
+.. _WAVEWATCH III: https://polar.ncep.noaa.gov/waves
+.. _Phase 1: https://polar.ncep.noaa.gov/waves/hindcasts/nopp-phase1.php
+.. _Phase 2: https://polar.ncep.noaa.gov/waves/hindcasts/nopp-phase2.php
+.. _Multigrid: https://polar.ncep.noaa.gov/waves/hindcasts/prod-multi_1.php
+.. _Singlegrid: https://polar.ncep.noaa.gov/waves/hindcasts/prod-nww3.php
+.. _WAVEWATCH III description: https://polar.ncep.noaa.gov/waves/wavewatch/
+.. _WAVEWATCH III hindcasts: http://polar.ncep.noaa.gov/waves/hindcasts/
+.. _WAVEWATCH III thredds: https://www.ncei.noaa.gov/thredds-ocean/catalog/ncep/nww3/catalog.html
+.. _Singlegrid data: https://polar.ncep.noaa.gov/waves/hindcasts/nww3/
+.. _Multigrid data: https://polar.ncep.noaa.gov/waves/hindcasts/multi_1/
+
+
+

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_templates/sidebaroutro.html

@@ -0,0 +1,3 @@
+<a href="https://csdms.colorado.edu">
+  <img src="_static/powered-by-logo-header.png" alt="Powered by CSDMS"/>
+</a>

docs/source/authors.rst

@@ -0,0 +1 @@
+.. include:: ../../AUTHORS.rst

docs/source/changes.rst

@@ -0,0 +1 @@
+.. include:: ../../CHANGES.rst

docs/source/conf.py

@@ -0,0 +1,73 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "wavewatch3"
+copyright = "2022, Eric Hutton"
+author = "Eric Hutton"
+
+# The full version, including alpha/beta/rc tags
+release = "0.1"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+html_static_path = ["_static", "images"]
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+html_theme_options = {
+    "description": "WAVEWATCH III datasets in Python.",
+    "logo": "wavewatch3_logo.png",
+    "logo_name": False,
+    "github_user": "csdms",
+    "github_repo": "wavewatch3",
+    "extra_nav_links": {
+        "WAVEWATCH III": "https://polar.ncep.noaa.gov/waves",
+        "wavewatch3 @ GitHub": "https://github.com/csdms/wavewatch3/",
+        "Contact Us": "https://github.com/csdms/wavewatch3/issues",
+    },
+}
+
+html_sidebars = {
+    "**": ["about.html", "searchbox.html", "navigation.html", "sidebaroutro.html"]
+}

docs/source/index.rst

@@ -0,0 +1,16 @@
+.. include:: ../../README.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   Release Notes <changes>
+   Contributors <authors>
+   License <license>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/license.rst

@@ -0,0 +1 @@
+.. include:: ../../LICENSE.rst

news/8.docs

@@ -0,0 +1,4 @@
+Added package description, installation, usage, and an example to the
+documentation.
+
+

news/8.feature

@@ -0,0 +1,5 @@
+Added a ``step`` property to ``WaveWatch3`` to track the current time slice
+of the data cube. This property is also settable so that a user can use it to
+advance throught the data (additional data are downloaded in the background as
+needed).
+