======
pybuoy
======

Python wrapper for `NOAA <https://www.noaa.gov>`_ and `NDBC <https://www.ndbc.noaa.gov>`_ REST web services.

.. note::

   This project is under active development.

**pybuoy**'s documentation is organized into the following sections:

- :ref:`getting_started`
- :ref:`code_overview`
- :ref:`tutorial`
- :ref:`package_info`

Contents
--------

.. _getting_started:

.. toctree::
    :maxdepth: 1
    :caption: Getting Started

    getting_started/quick_start
    getting_started/installation

.. _code_overview:

.. toctree::
    :maxdepth: 1
    :caption: Code Overview

    code_overview/buoy_instance
    code_overview/exceptions

.. _tutorial:

.. toctree::
    :maxdepth: 1
    :caption: Tutorials

    tutorials/active_buoys.rst
    tutorials/forecast_data.rst
    tutorials/realtime_data.rst

.. _package_info:

.. toctree::
    :maxdepth: 1
    :caption: Package Info

    package_info/changelog
    package_info/contributing
    package_info/references

.. toctree::
    :hidden:

    genindex