diff --git a/README.md b/README.md index ff0dbd9..3717b83 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,24 @@ # Python Data Science Handbook -This repository contains the entire [Python Data Science Handbook](http://shop.oreilly.com/product/0636920034919.do), in the form of (free!) Jupyter notebooks. +[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/jakevdp/PythonDataScienceHandbook/master?filepath=notebooks%2FIndex.ipynb) -You can read the book in its entirety online at https://jakevdp.github.io/PythonDataScienceHandbook/ +This repository contains the entire [Python Data Science Handbook](http://shop.oreilly.com/product/0636920034919.do), in the form of (free!) Jupyter notebooks. ![cover image](notebooks/figures/PDSH-cover.png) -The book was written and tested with Python 3.5, though older Python versions (including Python 2.7) should work in nearly all cases. +## How to Use this Book + +- Read the book in its entirety online at https://jakevdp.github.io/PythonDataScienceHandbook/ + +- Run the code using the Jupyter notebooks available in this repository's [notebooks](notebooks) directory. + +- Launch a live notebook server with these notebooks using [binder](https://beta.mybinder.org/): [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/jakevdp/PythonDataScienceHandbook/master?filepath=notebooks%2FIndex.ipynb) + +- Buy the printed book through [O'Reilly Media](http://shop.oreilly.com/product/0636920034919.do) + +## About + +The book was written and tested with Python 3.5, though other Python versions (including Python 2.7) should work in nearly all cases. The book introduces the core libraries essential for working with data in Python: particularly [IPython](http://ipython.org), [NumPy](http://numpy.org), [Pandas](http://pandas.pydata.org), [Matplotlib](http://matplotlib.org), [Scikit-Learn](http://scikit-learn.org), and related packages. Familiarity with Python as a language is assumed; if you need a quick introduction to the language itself, see the free companion project, @@ -14,7 +26,7 @@ Familiarity with Python as a language is assumed; if you need a quick introducti See [Index.ipynb](http://nbviewer.jupyter.org/github/jakevdp/PythonDataScienceHandbook/blob/master/notebooks/Index.ipynb) for an index of the notebooks available to accompany the text. -## Required Packages +## Software The code in the book was tested with Python 3.5, though most (but not all) will also work correctly with Python 2.7 and other older Python versions. diff --git a/notebooks/03.05-Hierarchical-Indexing.ipynb b/notebooks/03.05-Hierarchical-Indexing.ipynb index fcd7510..43e3475 100644 --- a/notebooks/03.05-Hierarchical-Indexing.ipynb +++ b/notebooks/03.05-Hierarchical-Indexing.ipynb @@ -1347,7 +1347,7 @@ "editable": true }, "source": [ - "Partial slicing is available as well, as long as the ``MultiIndex`` is sorted (see discussion in [Sorted and Unsorted Indices](#Sorted-and-Unsorted-Indices)):" + "Partial slicing is available as well, as long as the ``MultiIndex`` is sorted (see discussion in [Sorted and Unsorted Indices](#Sorted-and-unsorted-indices)):" ] }, { diff --git a/runtime.txt b/runtime.txt new file mode 100644 index 0000000..5cea6be --- /dev/null +++ b/runtime.txt @@ -0,0 +1 @@ +python-3.5 diff --git a/website/README.md b/website/README.md index b87e79d..b7f9249 100644 --- a/website/README.md +++ b/website/README.md @@ -1,6 +1,9 @@ # Tools for creating http://jakevdp.github.io/PythonDataScienceHandbook/ -## Building the Blog +The website is generated using the [Pelican](http://docs.getpelican.com/) static site generator. +The themes here are adapted from those used for my blog: https://github.com/jakevdp/jakevdp.github.io-source + +## Building the Website Clone the repository & make sure submodules are included @@ -19,6 +22,11 @@ $ source activate pelican-blog $ pip install pelican Markdown ghp-import ``` +Copy the notebook content to the right location (this script also modifies some links for the HTML): +``` +$ python copy_notebooks.py +``` + Build the html and serve locally: ``` @@ -31,4 +39,4 @@ Deploy to github pages ``` $ make publish-to-github -``` \ No newline at end of file +```