.. _index_ocean_sdk:

=========
Ocean SDK
=========

.. toctree::
    :hidden:
    :maxdepth: 1

    index_get_started
    packages
    dwave_cli
    source_code
    release_notes
    contribute

Ocean\ |tm| software is a suite of tools for using
`D-Wave Quantum Inc. <https://www.dwavesys.com>`_ quantum computers and
:term:`hybrid` :term:`solvers <solver>`.

This section documents **Ocean SDK version** |version|.

.. grid:: 3
    :gutter: 2

    .. grid-item-card:: :ref:`ocean_index_get_started`
        :img-top: /_images/rocket_icon.svg
        :link: ocean_index_get_started
        :link-type: ref

        Install and learn Ocean software.

    .. grid-item-card:: :ref:`ocean_packages`
        :img-top: /_images/documentation_icon.svg
        :link: ocean_packages
        :link-type: ref

        Application programming interface (API) documentation.

    .. grid-item-card:: :ref:`ocean_dwave_cli`
        :img-top: /_images/cli_icon.svg
        :link: ocean_dwave_cli
        :link-type: ref

        Command line interface (CLI) for installing the Ocean SDK and more.

    .. grid-item-card:: :ref:`ocean_source_code`
        :img-top: /_images/source_code_icon.svg
        :link: ocean_source_code
        :link-type: ref

        Links to Ocean software's packages.

    .. grid-item-card:: :ref:`ocean_release_notes`
        :img-top: /_images/release_notes_icon.svg
        :link: ocean_release_notes
        :link-type: ref

        Release notes for Ocean software's packages.

Example
=======

The :ref:`dwave setup <cli_example_setup>` command configures a development
environment on your local machine::

    $ dwave setup

==========
Contribute
==========

See the :ref:`ocean_contribute` section.