Metadata-Version: 2.4
Name: access-ccdtools
Version: 0.2
Summary: Cryosphere Community Datapool Tools (ccdtools), managed by ACCESS-NRI
Author: ACCESS-NRI
License: Apache-2.0
Project-URL: Homepage, https://github.com/ACCESS-NRI/ccdtools
Project-URL: Repository, https://github.com/ACCESS-NRI/ccdtools
Project-URL: Issues, https://github.com/ACCESS-NRI/ccdtools/issues
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: xarray
Requires-Dist: pandas
Requires-Dist: geopandas
Requires-Dist: rioxarray
Requires-Dist: numpy
Requires-Dist: PyYAML
Dynamic: license-file

<div align="center">
  <img src="docs/_static/ccdtools_logo_med.png" alt="ccdtools Logo" width="300"/>
</div>

# Cryosphere Community Datapool Tools (`ccdtools`)

[![PyPI](https://img.shields.io/pypi/v/access-cryosphere-data-pool)](https://pypi.org/project/access-cryosphere-data-pool/)
[![Conda](https://img.shields.io/conda/v/accessnri/access-cryosphere-data-pool)](https://anaconda.org/accessnri/access-cryosphere-data-pool)
[![Docs](https://app.readthedocs.org/projects/ccdtools/badge/?version=latest)](https://ccdtools.readthedocs.io/latest/)


---
## About
Welcome to the Cryosphere Community Datapool Tools (**ccdtools**)!

[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 repository contains the associated 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 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.


## Contributing
We welcome contributions from the community! If you're interested in contributing to **ccdtools** development or documentation, please check out our [Contributing guidelines](https://ccdtools.readthedocs.io/latest/contributing.html).

To request a new dataset to be added to the CCD or an update/edit to a currently supported dataset, please create an [issue here](https://github.com/ACCESS-NRI/ccdtools/issues) using the **"New Dataset Request"** template.

## Documentation
Read the [documentation here](https://ccdtools.readthedocs.io/latest/)

## License
[![License](https://img.shields.io/github/license/ACCESS-NRI/ccdtools)](https://github.com/ACCESS-NRI/ccdtools/blob/main/LICENSE)
