cal-adapt / climakitae

A Python toolkit for retrieving, visualizing, and performing scientific analyses with data from the Cal-Adapt Analytics Engine.
https://climakitae.readthedocs.io
BSD 3-Clause "New" or "Revised" License
19 stars 2 forks source link

View data options and retrieve data from catalog without using the GUI #398

Closed nicolejkeeney closed 1 month ago

nicolejkeeney commented 1 month ago

Description of PR

PLEASE READ PR DESCRIPTION FOR INSTRUCTIONS ON HOW TO REVIEW :D

This PR adds a few new functions that enable users to view the data options and retrieve data from the catalog without using the selections GUI or needing to work with the intake library. It's intended to be much easier to use than intake, with more user-friendly language that matches what we have in the selections GUI, while enabling more tech-savvy users to retrieve and subset data using a python function instead of a GUI.

I created a python notebook to showcase the functions I wrote!! Please run through this notebook in the hub to review the PR. I also hope to showcase this notebook and new functionality to the larger team at some point after getting reviews on this PR.

AE_catalog_access_and_download.ipynb.zip

Also, I improved the documentation on some existing functions that my new code utilizes :)

Type of change

How Has This Been Tested?

No tests written, not sure if these functions need them.

Checklist:

nicolejkeeney commented 1 month ago

Ugh, I was afraid we would get a cycular import issue...

Go ahead and put them in utils...

rats! I'll change it back :(

nicolejkeeney commented 1 month ago

I made some improvements as suggested by Tianchi and Eric! Everything looks good to me now. I will merge it shortly