diff options
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -1,2 +1,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 |