diff options
| author | Gabriel Kosmacher <73120774+kennykos@users.noreply.github.com> | 2023-02-15 16:12:31 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-15 16:12:31 -0600 |
| commit | 28c1eff12954a8c24d88fa4df036bd7221c919f3 (patch) | |
| tree | 9f0e68432200809698b0ec230d2125c309204f57 /README.md | |
| parent | eb4132862f19c157289f126e5a071863ebeedc2c (diff) | |
| parent | b6b578249e447614f7a9e07c7b2343e625d21101 (diff) | |
Merge pull request #1 from kennykos/main
Adding scripts to read & clean University of Illinois Investment Data, get yahoo! info for invested companies
Diffstat (limited to 'README.md')
| -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 |