Metadata-Version: 2.1
Name: climakitae
Version: 1.0.0
Summary: Climate data analysis toolkit
Home-page: https://github.com/cal-adapt/climakitae
Author: Cal-Adapt Analytics Engine Team
Author-email: analytics@cal-adapt.org
License: BSD 3-Clause License
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 1 - Planning
License-File: LICENSE
Requires-Dist: cartopy
Requires-Dist: dask-geopandas
Requires-Dist: geopandas
Requires-Dist: intake
Requires-Dist: intake-geopandas
Requires-Dist: intake-xarray
Requires-Dist: matplotlib
Requires-Dist: metpy
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: param
Requires-Dist: pyproj
Requires-Dist: rioxarray
Requires-Dist: s3fs
Requires-Dist: scipy
Requires-Dist: shapely
Requires-Dist: xarray
Requires-Dist: xclim
Provides-Extra: docs
Requires-Dist: Sphinx; extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"

Climakitae
==========
A python toolkit for retrieving, and performing scientific analyses with climate data from the [Cal-Adapt Analytics Engine](https://analytics.cal-adapt.org).

**Note:** This package is in active development and should be considered a work in progress. 

Documentation
-------------
Check out the official documentation on ReadTheDocs: https://climakitae.readthedocs.io/en/latest/ 

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

Install the latest version in development directly with pip.

```
pip install https://github.com/cal-adapt/climakitae/archive/main.zip
```

Basic Usage
-----------

```
import climakitae as ck                        # Import the package
from climakitae.core.data_interface import DataParameters
sel = DataParameters()                         # Pull up selections to make data settings
data = sel.retrieve()                          # Retrieve the data from the AWS catalog
data = ck.load(data)                           # Read the data into memory
```

Links
-----
* PyPI releases: https://pypi.org/project/climakitae/
* Source code: https://github.com/cal-adapt/climakitae
* Issue tracker: https://github.com/cal-adapt/climakitae/issues

Contributors
------------
[![Contributors](https://contrib.rocks/image?repo=cal-adapt/climakitae)](https://github.com/cal-adapt/climakitae/graphs/contributors)
