ndbc-api - v2025.06.09.1

Summary of core changes:

• Add support for high frequency radar data through THREDDS as native netcdf4
• Small adjustments to test formats
• Added documentation for the hfradar data mode
• Updated getdata to support hfradar as a mode with stationid used to pass one or more high frequency radar dataset identifiers (such as uswc_1km for United States West Coast data at a 1 kilometer resolution)

Bugfixes:

• None noted; some documentation updates to better reflect what parameters are used.

Future improvements:

• None noted.

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen 9 months ago

ndbc-api - v2024.12.20.1

Summary of core changes:

• Improve the default response format of available_realtime to return a list of the modes supported by a given station. full_response=True returns the URLs for available station, optionally as a dataframe.
• Update the parameters in API methods to reflect the migration from the netCDF4 package to the xarray package.
• Expose xarray keyword arguments to the save_xarray_dataset method.

Bugfixes:

• None noted; some documentation updates to better reflect what parameters are used.

Future improvements:

• None noted.

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen about 1 year ago

ndbc-api - v2024.12.02.1

Summary of core changes:

• Add python 3.12 support in CI
• Improve setup.py and pyproject.toml
• Include installation instructions for conda (from conda-forge) and installation from source
• Improved the flow of examples in the overview notebook
• Added a new CONTRIBUING.md which describes how to run tests and submit new features or requests.

Bugfixes:

• Fixed an example in the overview notebook which incorrectly formatted the lat-lon coordinates of an example buoy.
• Improved the descriptions on how to run tests, adding a new CONTRIBUTING.md

Future improvements:

• Include station metadata for get_data queries in which a single station is requested with use_opendap=True
• Align flag, parameter, and method names in light of the migration from netCDF4 to xarray
• Expose more of the xarray API for some common internal operations such as serializing netCDF4 data retrieved from the THREDDS API.

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen about 1 year ago

ndbc-api - v2024.11.17.1

Version v2024.11.17.1

Core Changes:

• Migrated from netCDF4 library to xarray and scipy

Bug Fixes:

• Corrected sign in overview notebook example longitude

Future Improvements:

• Include station metadata in single-station get_data calls with use_opendap=True
• Update the flags and method names to adopt xarray naming conventions

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen over 1 year ago

ndbc-api - v2024.10.15.1

Version v2024.10.15.1

Bug Fixes:

• Improved timestamp parsing for some NDBC Data Service modalities

Future Improvements:

• Note noted

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen over 1 year ago

ndbc-api - v2024.09.01.1

Version v2024.09.01.1

Major Changes:

• Added netcdf4 file support through the get_data method when passing the flag use_opendap=True

Minor Changes:

• updated tests
• improved overview.ipynb documentation to reflect new netcdf4 support

Bug Fixes:

• None noted

Future Improvements:

• Note noted

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen over 1 year ago

ndbc-api - v2024.08.28.1

Version v2024.08.28.1

Major Changes:

• Update api.stations(), api.nearest_station(...) and api.radial_search(...) to include all of the ~1380 active stations which are tracked by the NDBC data service.
  • Added api.historical_stations() which returns the historical and current station deployments, with one row for each station, deployment period tuple.

Minor Changes:

• updated tests
• improved overview.ipynb documentation

Bug Fixes:

• Issue #40 (return all active stations) addressed in this PR

Future Improvements:

• Issue #40 (support netcdf data export) will be addressed in a subsequent release

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen over 1 year ago

ndbc-api - v2024.08.04.1

Version v2024.08.04.1

Major Changes:

• Logging refactor
  • the api now supports structured logging

Minor Changes:

• messages are logged at logging.DEBUG, logging.INFO, and logging.WARN with the default log level set to logging.ERROR
• failed staion-mode pairs in get_data no longer result in messages logged at logging.ERROR

Bug Fixes:

• #36 (continuation with the logging refactor)

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen over 1 year ago

ndbc-api - v2024.07.28.1

Version v2024.07.28.1

Major Changes:

• Python 3.7 support is now best-effort using requirements.txt

Minor Changes:

• Migrated from setup.py to pyproject.toml for package management
• Poetry support for dependency management

Bug Fixes:

• #36 station_ids logging improvements

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen over 1 year ago

ndbc-api - v2024.06.12.1

Version v2024.06.12.1

Major Changes:

• Update API's get_data() method to support station_ids and modes which allow for parallelism in data queries across stations (e.g. [tplm2, apam2]) or modes (e.g. [stmet, cwind])
• Update overview.ipynb to better describe API functionality

Minor Changes:

• Updated PyPi versions and contact information
• migrated BeautifulSoup4 dependency from bs4 to beautifulsoup4
• added yapf as a development dependency
• formatting improvements

Bug Fixes:

• None noted

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen over 1 year ago

ndbc-api - v0.24.1.6.1

Version 0.24.1.6.1

Major Fixes:

• Update overview.ipynb to better describe API functionality

Major Changes:

• Tests made compatible with pandas==2.1.4

Minor Changes:

• Cleaned README.md
• Updated PyPi versions and contact information

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen about 2 years ago

ndbc-api - v0.23.7.31

Version 0.23.7.31

Major Fixes:

• Update available_realtime method to handle latest NDBC buoy web page format

Major Changes:

• Update handling of station metadata as pd.DataFrame (default dict behavior remains unchanged) #20 #21
• New example notebook #20 #21
• Updated documentation #24
• Validated tests #21

Minor Changes:

• Improved docstrings where needed
• Cleaned README.md
• Updated PyPi versions and contact information

Scientific Software - Peer-reviewed - Jupyter Notebook
Published by CDJellen over 2 years ago