toriis-analysis

Repository for scripts to evaluate public institutional investment data. These scripts are designed to be launched with binder so that other community members can run their own analyses without any additional setup.

Running existing notebook

1. Interactive, UI-only: Launch the repo in binder and clone one of the example notebooks
2. Interactive, CLI only:
   1. Fork + clone repo
   2. Run setup/setup.sh to set up the local conda environment
      • you may need to install the correct version of miniconda
   3. 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. UI-only:
   1. Download the notebook (Download -> ipynb)
   2. Upload the notebook using the GitHub UI (Upload Files, next to Clone or Download)
2. CLI only: Follow the instructions on github - i.e.
   1. Create a new branch (e.g. $ git checkout -b)
   2. Commit the new notebook (e.g. $ git add and $ git commit)
   3. Push and generate pull request