Added two notebooks showcasing the library.

The first notebook, `kickscore-basics`, goes step-by-step through a basic example whereas `nba-history` is a case study on a real-world dataset of NBA games.
lucasmaystre · Jul 25, 2019 · 4c5aaa3 · 4c5aaa3
1 parent 0081e7c
commit 4c5aaa3
Show file tree

Hide file tree

Showing 4 changed files with 591 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,7 @@
 /.eggs/
 /_novcs/
 .cache/
+examples/nba_elo.csv
 
 # Sphinx-generated doc.
 docs/_build

diff --git a/README.rst b/README.rst
@@ -18,6 +18,15 @@ To install the latest release directly from PyPI, simply type::
 
     pip install kickscore
 
+To get started, you might want to explore one of these notebooks:
+
+- `Basic example illustrating the API <examples/kickscore-basics.ipynb>`_
+  (`interactive version
+  <https://colab.research.google.com/github/lucasmaystre/kickscore/blob/master/examples/kickscore-basics.ipynb>`_)
+- `Visualizing the history of the NBA <examples/nba-history.ipynb>`_
+  (`interactive version
+  <https://colab.research.google.com/github/lucasmaystre/kickscore/blob/master/examples/nba-history.ipynb>`_)
+
 References
 ----------
 

diff --git a/examples/kickscore-basics.ipynb b/examples/kickscore-basics.ipynb
diff --git a/examples/nba-history.ipynb b/examples/nba-history.ipynb