diff options
| author | Gabriel Kosmacher <73120774+kennykos@users.noreply.github.com> | 2023-03-13 13:22:02 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-13 13:22:02 -0500 |
| commit | 8e3b0bfe3487044cce57d78d803b1c8f8cbe37c5 (patch) | |
| tree | f033ede7b3b855af02c4a331405728af93c3904e /README.md | |
| parent | 28c1eff12954a8c24d88fa4df036bd7221c919f3 (diff) | |
| parent | d92093d87deee8b0a03a13af4a53f78753e9ab77 (diff) | |
Merge pull request #4 from kennykos/1-set-up-binder
1 set up binder
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 19 insertions, 9 deletions
@@ -1,19 +1,29 @@ +[](https://github.com/toriis-portal/toriis-analysis/actions/workflows/analysis-notebook-test-binder.yml) # 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 + |