Skip to content

Commit

Permalink
feat: extend available index
Browse files Browse the repository at this point in the history
  • Loading branch information
blizhan committed Nov 22, 2023
1 parent f674d21 commit 0a32992
Show file tree
Hide file tree
Showing 9 changed files with 521 additions and 8 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ __pycache__
*_checkpoints
*egg-info
*dist
*build
*build
*.ipynb
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The following support
|--|--|--|--|--|
|IRI|IRI|forecast|ENSO Probability|`Climate_Maester(['enso'], 'iri').forecast(pred_at=date)`|
|IRI|CPC|forecast|ENSO Probability|`Climate_Maester(['enso'], 'cpc').forecast(pred_at=date)`|
|JAMSTEC|JAMSTEC|forecast| Dipole Mode Index|`Climate_Maester(['dmi'], 'jamstec').forecast()`|
|PSL/NCEI|PSL/NCEI|history|Nina 34 Anomaly|`Climate_Maester(['nina34a'], 'ncei').history()`|
|PSL/NCEI|PSL/NCEI|history|Nina 3 Anomaly|`Climate_Maester(['nina3'], 'ncei').history()`|
|PSL/NCEI|PSL/NCEI|history|Nina 4 Anomaly|`Climate_Maester(['nina4'], 'ncei').history()`|
Expand All @@ -27,16 +28,25 @@ The following support
|PSL|PSL|history|Bivariate ENSO from nina3.4 & soi|`Climate_Maester(['censo'], 'psl').history()`|
|PSL|PSL|history|Western Pacific Index|`Climate_Maester(['wp'], 'psl').history()`|
|PSL|PSL|history|AMO smoothed|`Climate_Maester(['amo_sm'], 'psl').history()`|
|PSL|PSL|history|Dipole Mode Index|`Climate_Maester(['dmi'], 'psl').history()`|
|PSL|PSL|history|Dipole Mode Index West|`Climate_Maester(['dmiwest'], 'psl').history()`|
|PSL|PSL|history|Dipole Mode Index East|`Climate_Maester(['dmieast'], 'psl').history()`|
|PSL|PSL|history|North Atlantic Oscillation|`Climate_Maester(['nao'], 'psl').history()`|
|PSL|PSL|history|North Pacific Index|`Climate_Maester(['np'], 'psl').history()`|
|PSL|PSL|history|Trans Polar Index|`Climate_Maester(['tpi'], 'psl').history()`|
|PSL|PSL|history|Global Average Temperature Anomaly from Station|`Climate_Maester(['glbts'], 'psl').history()`|
|PSL|PSL|history|Global Average Temperature Anomaly from Station and SST|`Climate_Maester(['glbtssst'], 'psl').history()`|
|PSL/NCEI|PSL/NCEI|history|AMO unsmoothed|`Climate_Maester(['amo'], 'ncei').history()`|
|PSL/NCEI|PSL/NCEI|history|Pacific Decadal Oscillation|`Climate_Maester(['pdo'], 'ncei').history()`|



### Install
```shell
pip install maesters-clim
```

### Usage
### [Usage](example/climate_index.ipynb)
```python
from maesters_of_clim import Climate_Maester
from datetime import datetime
Expand Down
Loading

0 comments on commit 0a32992

Please sign in to comment.