WIP: Jupyter Notebooks

[sarahmorin]

This branch is not done, but feedback would be helpful!

Notebooks

• Instructions for local set up
• Basic R2B2 Usage
  • Draft done, needs refinement
• Generating a graph using a bulk method
• Comparison of audits using interactive run() method.
  • Draft done, needs refinement

Ideas

• Notebooks to explain each audit

[codecov]

Codecov Report

Merging #21 into master will increase coverage by 0.53%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #21      +/-   ##
==========================================
+ Coverage   82.62%   83.16%   +0.53%     
==========================================
  Files          13       14       +1     
  Lines         685      879     +194     
  Branches       92      160      +68     
==========================================
+ Hits          566      731     +165     
- Misses        108      132      +24     
- Partials       11       16       +5     

Impacted Files	Coverage Δ
src/r2b2/tests/util.py	28.30% <0.00%> (-1.49%)	⬇️
src/r2b2/audit.py	65.78% <0.00%> (-0.53%)	⬇️
src/r2b2/tests/test_audit.py	98.66% <0.00%> (-0.51%)	⬇️
src/r2b2/cli.py	100.00% <0.00%> (ø)
src/r2b2/contest.py	100.00% <0.00%> (ø)
src/r2b2/tests/test_contest.py	100.00% <0.00%> (ø)
tests/test_brla.py	100.00% <0.00%> (ø)
src/r2b2/brla.py	90.27% <0.00%> (+9.22%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9353945...aec0216. Read the comment docs.

[nealmcb]

I haven't tried all the different approaches here, but my guess is that the advice for interim use and development should be to use
pip install --editable ./ vs
python setup.py build install and the like, as discussed at
https://stackoverflow.com/questions/30306099/pip-install-editable-vs-python-setup-py-develop
and in the security warning at https://pip.pypa.io/en/stable/reference/pip_install/

[sarahmorin]

I haven't tried all the different approaches here, but my guess is that the advice for interim use and development should be to use
pip install --editable ./ vs
python setup.py build install and the like, as discussed at
https://stackoverflow.com/questions/30306099/pip-install-editable-vs-python-setup-py-develop
and in the security warning at https://pip.pypa.io/en/stable/reference/pip_install/

Thanks, good note!