Metadata-Version: 2.1
Name: climate-resilience
Version: 0.1.8
Summary: Download, Preprocessing, and Visualization code for climate resilience data.
Home-page: https://github.com/satyarth934/lbnl-climate-resilience
Author: ['Satyarth Praveen', 'Zexuan Xu']
Author-email: satyarth@lbl.gov
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/satyarth934/lbnl-climate-resilience/issues
Project-URL: Source, https://github.com/satyarth934/lbnl-climate-resilience
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# lbnl-climate-resilience

[pip package](https://pypi.org/project/climate-resilience/)

---
## Download [Examples](./examples/climate-resilience/download_example.py)
We cannot directly download the data from the Google Earth Engine directly onto 
the local machine. So the best option is to download to the drive and then 
download that data to the local drive.

---
## Preprocess [Examples](./examples/climate-resilience/preprocess_example.py)
The preprocessing functions will expect that the local data drive contains the 
downloaded data.

If the data is on drive, the drive needs to be mounted. This is easier to do in 
a google colab session. Then the path of the mounted drive can be used with the 
functions as normal.

#### Expected file and directory structure:
The input file and directory structure for functions `calculate_Nth_percentile()`, `calculate_pr_count_amount()`, and `calculate_temporal_mean()` in the [preprocessing code](./src/climate_resilience/preprocess.py) should be as follows:
```
datadir
├── scenario1_variable1_ensemble
│   ├── name1_state1_scenario1_variable1.csv
│   └── name2_state2_scenario1_variable1.csv
├── scenario1_variable2_ensemble
│   ├── name1_state1_scenario1_variable2.csv
│   └── name2_state2_scenario1_variable2.csv
├── scenario2_variable1_ensemble
│   ├── name1_state1_scenario2_variable1.csv
│   └── name2_state2_scenario2_variable1.csv
└── scenario2_variable2_ensemble
    ├── name1_state1_scenario2_variable2.csv
    └── name2_state2_scenario2_variable2.csv
```

---
## Visualize Examples [1](./notebooks/climate-resilience/visualize_example_1.ipynb), [2](./notebooks/climate-resilience/visualize_example_2.ipynb), and [3](./notebooks/climate-resilience/visualize_example_3.ipynb)
The visualization code will be easier to be used in a notebook as inline 
visualizations can be used.


