diff options
| -rw-r--r-- | README.md | 27 |
1 files changed, 18 insertions, 9 deletions
@@ -1,19 +1,28 @@ # toriis-analysis -Repository for scripts to evaluate public institutional investment data. +Repository for scripts to evaluate public institutional investment data. These scripts are designed to be launched with [binder](https://mybinder.org/) so that other community members can run their own analyses without any additional setup. + + + +[](https://mybinder.org/v2/gh/toriis-portal/toriis-analysis/HEAD) # Running existing notebook -1) - + Fork + clone repo - + Run `setup/setup.sh` to set up the local conda environment +1. **Interactive, UI-only:** Launch the repo in binder and clone one of the example notebooks +1. **Interactive, CLI only:** + 1. Fork + clone repo + 1. 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`) + 1. 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 +1. **UI-only:** + 1. Download the notebook (Download -> ipynb) + 1. Upload the notebook using the GitHub UI (Upload Files, next to Clone or Download) +1. **CLI only:** Follow the [instructions on github](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) - i.e. + 1. Create a new branch (e.g. `$ git checkout -b`) + 1. Commit the new notebook (e.g. `$ git add` and `$ git commit`) + 1. Push and generate pull request + |