Skip to content

Update README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
computron wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ Installation is easy with pip
pip install pvcz
```

Note that you should make sure you have:
- pandas (v0.24.2 or higher to ensure that the ``pickle`` serialization used by this package works as intended)
- For plotting, you will need to install matplotlib BaseMap (https://matplotlib.org/basemap/users/installing.html#installation)

# About
The data is calcuated from the global land data accumulation service (GLDAS) at 0.25 degree resolution across the world.

Expand Down Expand Up @@ -41,7 +45,7 @@ The following code snippet shows how to find the climate stressors and zones clo
```python
import pvcz

# Note df is a flattened list of lat/lon values that only includes those over land
# Note df is a flattened pandas.DataFrame of lat/lon values that only includes those over land
df = pvcz.get_pvcz_data()

# Point of interest specified by lat/lon coordinates.
Expand Down Expand Up @@ -102,4 +106,4 @@ cbar.set_label('Equivalent Temperature, Rack (C)')

plt.show()
```