Release Notes#
Not yet released (2023-09-12)#
Bug Fixes#
Fixed an installation bug where the tests folder was being installed as a package in site-packages. #14
Documentation Enhancements#
Added documentation, using the furo theme, to appear on
readthedocs.io <https://bmi-wavewatch3.readthedocs.io>
_. #14Updated the installation instructions to prefer conda installation over pip to fix eccodes errors. #17
Cleaned up the documentation and switched formats from reStructuredText to MyST-flavored markdown. #74
Other Changes and Additions#
Added a GitHub Actions workflow that checks to see that pull requests contain at least one news fragment. #14
Added a nox configuration file, noxfile.py, that scripts some routine package maintenance tasks. #15
Updated the requirements to fix eccodes errors on Linux and MacOS. #17
Added Python 3.11 to the ci builds and dropped Python 3.8. #18
Added a CFF-formated citation file that points to the v0.2.0 (Admirable Angelfish) release. #73
0.2.0 (2022-06-17)#
New Features#
Added a new subcommand, plot, to the ww3 command-line program.
ww3 plot
with download (if the data files are not already cached) and create a plot of the requested data. (#13)
Bug Fixes#
Fixed a bug in the reporting of an error caused by an invalide datatime string. (#13)
0.1.1 (2022-06-10)#
Other Changes and Additions#
Set up GitHub Action to create a source distribution and push it to TestPyPI. This action is only run if the version tag is a prerelease version (i.e. the version string ends with
[ab][0-9]+
). (#10)Set up GitHub Action to create a source distribution and push it to PyPI. This action is only run if the version tag is a release version (i.e. the version string doesn’t end with
[ab][0-9]+
). (#11)
0.1.1b1 (2022-06-09)#
New Features#
Added
ww3
command line interface to download WaveWatch III data by date, region and quantity (significant wave height, wind speed, etc.). (#1)Added
WaveWatch3
class, which is the main access point for users of this package. This class downloads WaveWatch III data files (if not already cached) and provides a view of the data as an xarray Dataset. Users can then advance through the data month-by-month, downloading additional data as necessary. (#3)Added the
ww3 clean
subcommand that removes cached data files. (#4)Added
BMIWaveWatch3
class to provide a Basic Model Interface for the wavewatch3 package. (#5)Added additional WaveWatch III data sources from which users can fraw data from. (#6)
Added
fetch
method to WaveWatch3 to mimic the command line programww3 fetch
. (#7)Added additional data sources from which to retreive data from. Available data sources now include: Phase 1, Phase 2, Multigrid, Multigrid-extended, and Multigrid-thredds. (#7)
Added
ww3 info
command to print information (e.g. available grids, quantities, etc.) about data sources. (#7)Added a
step
property toWaveWatch3
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). (#8)Dates can now be specified as iso-formatted date/time strings. For example, “1944-06-06T06:30”. (#8)
Rename package to
bmi_wavewatch3
. This follows the convention used by other CSDMS data components. (#9)
Documentation Enhancements#
Added package description, installation, usage, and an example to the documentation. (#8)
Other Changes and Additions#
Set up continuous integration using GitHub actions. This includes tests to ensure that the code is styled according to black, is free of lint, and passes all unit tests. (#2)
Added more unit tests, particularly for data sources. (#7)
Added a GitHub action to build the sphinx-based documentation as part of the continuous integration. (#8)
Better error reporting for the command line interface for HTTP errors when retreiving data as well as input validation. (#8)
Set up GitHub Action to create a source distribution and push it to TestPyPI. This action is only run if the version tag is a prerelease version (i.e. the version string ends with
[ab][0-9]+
). (#10)