Metadata-Version: 2.1
Name: climakitae
Version: 1.0.1
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: pip ==22.2.2
Requires-Dist: boltons ==24.0.0
Requires-Dist: lmoments3 ==1.0.7
Requires-Dist: jsonpickle ==3.3.0
Requires-Dist: llvmlite ==0.36.0
Requires-Dist: bottleneck ==1.3.5
Requires-Dist: boto3 ==1.24.59
Requires-Dist: tqdm ==4.64.1
Requires-Dist: pydantic ==1.10.2
Requires-Dist: pyarrow ==9.0.0
Requires-Dist: xarray ==2022.6.0
Requires-Dist: dask ==2022.9.1
Requires-Dist: cartopy ==0.21.0
Requires-Dist: dask-gateway ==2022.6.1
Requires-Dist: geopandas ==0.11.1
Requires-Dist: intake ==0.6.6
Requires-Dist: intake-xarray ==0.6.1
Requires-Dist: intake-esm ==2022.9.18
Requires-Dist: jinja2 ==3.1.2
Requires-Dist: matplotlib ==3.6.0
Requires-Dist: metpy ==1.3.1
Requires-Dist: numpy ==1.23.3
Requires-Dist: pandas ==1.5.0
Requires-Dist: param ==1.12.2
Requires-Dist: psutil ==5.9.2
Requires-Dist: pyproj ==3.4.0
Requires-Dist: pytest ==7.1.3
Requires-Dist: rioxarray ==0.12.2
Requires-Dist: s3fs ==2022.8.2
Requires-Dist: scipy ==1.9.1
Requires-Dist: shapely ==1.8.4
Requires-Dist: pygeos ==0.13
Requires-Dist: statsmodels ==0.13.2
Requires-Dist: numba ==0.53.1
Requires-Dist: timezonefinder ==6.0.2
Requires-Dist: dask-geopandas ==0.3.1
Requires-Dist: xclim ==0.42.0
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)
