Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Corrections to README
  • Loading branch information
filipinascimento authored Jan 6, 2021
1 parent 470b8c7 commit 41d90b4
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This repository holds a collection of python notebooks that can be used to repli
## Publication
Filipi N Silva, , Didier A. Vega-Oliveros, Xiaoran Yan, Alessandro Flammini, Filippo Menczer, Filippo Radicchi, Ben Kravitz, and Santo Fortunato. "Detecting climate teleconnections with Granger causality." arXiv:2012.03848 [physics.ao-ph] (2020). http://arxiv.org/abs/2012.03848


## Authors
- Filipi N. Silva
- Didier A. Vega-Oliveros
Expand All @@ -15,6 +16,7 @@ Filipi N Silva, , Didier A. Vega-Oliveros, Xiaoran Yan, Alessandro Flammini, Fil
- Ben Kravitz
- Santo Fortunato


## How to use

- First download the preprocessed data from zenodo and save it in `Data` Folder.
Expand All @@ -23,13 +25,16 @@ Filipi N Silva, , Didier A. Vega-Oliveros, Xiaoran Yan, Alessandro Flammini, Fil
- Use the `DrawMaps` notebook to construct a figure with the data.
- You can load your own data by loading and converting it in the `ParseData` notebook.


### Data
The `Data` folder contains example output data used in the article for Granger Causality (`Causality_d7_l<maxLag>_v3.csv`) and Lagged Correlation (`Causality_d30_l<maxLag>_v3.csv`).
The preprocessed data is avaiable on zenodo: https://dx.doi.org/10.5281/zenodo.4270623


### Dependencies
Dependencies are listed in `requirements.txt`.


## TODO
- Make it modular and release it as a pyPI package.

Expand Down

0 comments on commit 41d90b4

Please sign in to comment.