https://github.com/cal-adapt/climakitae

A Python toolkit for retrieving, visualizing, and performing scientific analyses with data from the Cal-Adapt Analytics Engine.
https://github.com/cal-adapt/climakitae

Last synced: 3 months ago
JSON representation

A Python toolkit for retrieving, visualizing, and performing scientific analyses with data from the Cal-Adapt Analytics Engine.

• Host: GitHub
• URL: https://github.com/cal-adapt/climakitae
• Owner: cal-adapt
• License: bsd-3-clause
• Created: 2021-11-09T01:48:13.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-05T17:31:49.000Z (5 months ago)
• Last Synced: 2024-06-05T19:28:43.737Z (5 months ago)
• Language: Python
• Homepage: https://climakitae.readthedocs.io
• Size: 89.4 MB
• Stars: 19
• Watchers: 5
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• open-sustainable-technology - Climakitae - Enable a transition from climate vulnerability assessments to decision support for investor-owned utilities and other stakeholders. (Climate Change / Climate Data Processing and Analysis)

README

        
Climakitae

==========

A python toolkit for retrieving, visualizing, 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

sel = ck.Select().show()                       # Pull up selections GUI to make data settings

data = sel.retrieve()                          # Retrieve the data from the AWS catalog

data = ck.load(data)                           # Read the data into memory

ck.view(data)                                  # Generate a basic visualization of the data

from climakitae.explore import warming_levels  # Import warming levels code

wl = warming_levels().show()                   # Explore Warming Levels GUI

```

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)