.. image:: ../_static/ccdtools_logo_med.png
   :align: center
   :width: 300px
   :alt: ccdtools Logo

Cryosphere Community Datapool Tools (`ccdtools`)
=========================================

Welcome to the Cryosphere Community Datapool Tools (**ccdtools**) documentation!

`The Cryosphere Community Datapool (CCD) <https://docs.access-hive.org.au/model_evaluation/data/cryosphere_datapool/>`_ is a joint data sharing and 
discovery project between `ACCESS-NRI <https://www.access-nri.org.au/>`_ and the `Cryospheric Sciences Working Group (CSWG) <https://forum.access-hive.org.au/c/cryosphere/34>`_. 
The `CCD` has been designed as an open-access and freely available cryospheric data resource for the Australian scientific community, maintaining a 
variety of datasets commonly used to parameterise ice sheet models. The `CCD` is hosted on the National Computational Infrastructure (NCI) Gadi supercomputer 
within project `av17`.

This documentation describes the `CCD` Python interface **ccdtools** developed by `ACCESS-NRI <https://www.access-nri.org.au/>`_ that provides seamless 
access to the data located within the `CCD`. The **ccdtools** library offers an intuitive interface for discovering, accessing, and analysing diverse data sources 
including satellite observations, in-situ measurements, and model outputs. The library features a powerful dataset catalog system, enabling users to efficiently 
retrieve and work with data commonly used for ice sheet modelling, climate analysis, and cryospheric studies. 

As an open-source projects, both `CCD` and **ccdtools** encourage contributions from the community to expand both dataset offerings and enhance functionality.

Please see the `ACCESS-Hive Docs CCD page <https://docs.access-hive.org.au/model_evaluation/data/cryosphere_datapool/>`_ for a full list and description of all available datasets.

.. warning::
   `ccdtools` is under active development and remains a work in progress. Please let us know if anything is missing or if you have any suggestions for improvements by creating an `issue on our GitHub repository <https://github.com/ACCESS-NRI/ccdtools/issues>`_.

Quick Links
-----------
- :doc:`Overview <overview>` - A high-level introduction to **ccdtools** features and capabilities.
- :doc:`Installation <installation>` - Instructions for installing and using **ccdtools** in your Python environment.
- :doc:`Tutorials <tutorials>` - Hands-on tutorials demonstrating the use of **ccdtools**.
- :doc:`API Reference <ccdtools>` - Detailed API documentation for **ccdtools** submodules and classes.
- :doc:`Contributing Guidelines <contributing>` - How to contribute to **ccdtools** development and documentation.

Getting Started
---------------

To get started with **ccdtools**, please refer to the :doc:`installation <installation>` guide and the :doc:`overview <overview>` section for a comprehensive introduction to the library's features and capabilities.

Tutorials
---------
For hands-on tutorials, please refere to the :doc:`tutorials <tutorials>` section.

Contributing
------------
We welcome contributions from the community! If you're interested in contributing to **ccdtools** development or documentation, please check out our :doc:`contributing guidelines <contributing>`.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   overview
   installation
   tutorials
   ccdtools
   contributing