Notes used to give tutorials
Pull request Compare This branch is 910 commits behind scipy-lectures:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_static First sketch of hide/show for paragraphs. Apr 5, 2013
_templates adding possibility to edit document sources directly on github Oct 25, 2013
advanced Merge pull request scipy-lectures#102 from mriehl/master Oct 26, 2013
data prompt fixes etc.. Jan 20, 2013
guide Add notes on collapsable paragraphs in the contributors guide Apr 7, 2013
includes Layout Jun 20, 2012
intro fix typo Oct 27, 2013
misc More cleanup Feb 16, 2011
packages Merge branch 'master' of github.com:scipy-lectures/scipy-lecture-notes Nov 14, 2013
pyplots MAINT: change simple FFT example to be more understandable/realistic. Aug 12, 2012
sphinxext add new ipython_console_highlighting Jan 14, 2013
themes More padding on buttons Aug 21, 2013
.gitignore Update gitignore Oct 16, 2011
.mailmap Fix .mailmap Aug 10, 2012
AUTHORS.rst add jjhelmus to list of contributors Apr 16, 2013
CHANGES.rst Release for euroscipy Aug 21, 2013
LICENSE.rst Layout for web publishing Aug 24, 2011
Makefile Fix bug in example Aug 22, 2013
PRESENTING.txt More cleanup Feb 16, 2011
README.rst add missing requirement skimage Oct 25, 2013
blank_image.png Fix: add missing files Oct 16, 2011
conf.py ENH: modernize the Mayavi chapter Aug 22, 2013
euroscipy2010.svg Reorganize the repo Feb 16, 2011
euroscipy_back.pdf Reorganize the repo Feb 16, 2011
euroscipy_simple.svg Reorganize the repo Feb 16, 2011
index.rst scikit-image tutorial given at euroscipy 2013 Aug 22, 2013
testing.py Fix many doctest errors Jun 20, 2012
tune_toc.rst Clean up foldable tocs Aug 20, 2013

README.rst

Scipy-Lecture-Notes

This repository gathers some lecture notes on the scientific Python ecosystem that can be used for a full course of scientific computing with Python.

These documents are written with the rest markup language (.rst extension) and built using Sphinx: http://sphinx.pocoo.org/.

You can view the online version at: http://scipy-lectures.github.io

Reusing and distributing

As stated in the LICENSE.txt file, this material comes with no strings attached. Feel free to reuse and modify for your own teaching purposes.

However, we would like this reference material to be improved over time, thus we encourage people to contribute back changes. These will be reviewed and edited by the original authors and the editors.

Building instructions

To generate the html output for on-screen display, Type:

make html

the generated html files can be found in build/html

The first build takes a long time, but information is cached and subsequent builds will be faster.

To generate the pdf file for printing:

make pdf

The pdf builder is a bit pointy and you might have some TeX errors. Tweaking the layout in the *.rst files is usually enough to work around these problems.

Requirements

probably incomplete

  • make
  • sphinx (>= 1.0)
  • pdflatex
  • pdfjam
  • matplotlib
  • scikit-learn (>= 0.8)
  • scikit-image

Contributing

Contributing guide and chapter example

The directory guide contains an example chapter with specific instructions on how to contribute.

.. toctree::

   guide/index.rst