summaryrefslogtreecommitdiff
path: root/README.md
blob: e135132db2a1c94d8328f077cba94f2d735c7d4d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# toriis-analysis
Repository for scripts to evaluate public institutional investment data.

# Running existing notebook

1) 
	+ Fork + clone repo
	+ Run `setup/setup.sh` to set up the local conda environment
		- you may need to install the correct version of miniconda
	+ Start a local notebook suerver (`juypter notebook`)

# Contributing

You are welcome to contribute data and analysis results. Please make sure that you contribute **cleared notebooks** so version control capabilities work well. To clear a notebook, use `Kernel -> Researt & Clear Output)` 

1) **CLI:**
	+ Create a new branch (`$ git checkout -b <branch_name>`)
	+ Commit the new notebook/data (`$ git add <new file>; git commit`)
	+ Push and generate a pull request