CCAO Python package
===================

.. toctree::
   :hidden:
   :caption: Contents:

   reference

.. toctree::
   :hidden:
   :caption: Appendix:

   authors
   license
   Source Code <https://github.com/ccao-data/ccao>

This is a Python version of the ``ccao`` `R
package <https://ccao-data.github.io/ccao/>`_, providing utilities for
managing, distributing, and version controlling CCAO-specific functions
used throughout CCAO applications, models, and diagnostics. For generalized
versions of assessment-related functions, see
`assesspy <https://github.com/ccao-data/assesspy>`_.

For detailed documentation on included functions and data, `visit the full reference
list <https://ccao-data.github.io/ccao/python/reference.html>`_.


Installation
------------

Install the latest release of ``ccao`` from PyPI:

.. code-block:: python

    pip install ccao

You can also install the most recent code directly from GitHub:

.. code-block:: python

    pip install "git+https://github.com/ccao-data/ccao.git#egg=ccao&subdirectory=python"