Skip to content

Latest commit

 

History

History
153 lines (105 loc) · 6.32 KB

README.md

File metadata and controls

153 lines (105 loc) · 6.32 KB
Raw

PyData Cookbook

We are starting a project to build a cookbook of advanced material for the PyData community. The cookbook will be published by Addison-Wesley. We have invited a number of contributors to see if such a project would have some interest and received overwhelmingly positive feedback.

The book will cover several major topics, organized as such, with some sample packages:

  • IDE: IPython/Jupyter
  • Data Structures / Numerics: NumPy, Pandas, Xray, PyTables
  • Viz: Matplotlib, PyViz (HoloViews, Bokeh, Datashader), Seaborn, yt
  • Algorithms / Science: SciPy, Scikit-learn, Scikit-image, statsmodels, sympy, gensim, XGBoost
  • Performance / Scale: Cython, Numexpr, Numba, Dask, pyspark

We expect each submission to be about 15 - 20 pages describing an example of the power of each library. While we have reached out to the projects about putting each submission together we are happy to accept chapters for libraries we did not initially identify.

FAQ

Q: There are normally royalties for book authors. What happens to those?

A: All royalties go to NumFOCUS and will be used to support the further development of projects in the PyData stack.

Q: Is all content we contribute reusable for documentation of projects?

A: We can use chapters for documentation of projects but not a collection of all chapters in one volume. Essentially, there needs to be some value to buying the book to be published.

Instructions for Reviewers

  • Click on the Pull Requests Tab and browse to find the chapters assigned to you
  • After reading the paper, you can start the review conversation by simply commenting on the chapter, taking into consideration the suggested review criteria.
  • Authors will then respond to the comments and/or modify the paper to address the comments.
  • This will begin an iterative review process where authors and reviewers can discuss the evolving submission.
  • Reviewers may also apply one of the labels 'needs-more-review', 'pending-comment', or 'unready' to flag the current state of the review process.
  • Only once a reviewer is satisfied that the review process is complete and the submission should be accepted to the proceedings, should they affix the 'ready' label.
  • Reviewers should come to a final 'ready', 'unready' decision before July 10th at 18:00 PST.

Instructions for Authors

Submissions must be received by March 31st, 2018 at 23:59 PST, but modifications are allowed during the open review period which ends Dec 15th at 18:00 PST. Submissions are considered received once a Pull Request has been opened following the procedure outlined below.

Papers are formatted using reStructuredText and the compiled version should be no longer than 25 pages, including figures. Here are the steps to produce a paper:

  • Fork the pydata-cookbook repository on GitHub.

  • An example paper is provided in examples/00_vanderwalt. Create a new directory papers/firstname_surname, copy the example paper into it, and modify to your liking.

  • Run ./make_paper.sh papers/firstname_surname to compile your paper to PDF (requires LaTeX, docutils, Python--see below). The output appears in output/firstname_surname/paper.pdf.

  • Once you are ready to submit your paper, file a pull request on GitHub.

  • Please do not modify any files outside of your paper directory.

Schedule Summary

Authors may make changes to their submissions throughout the review process.

There are many different styles of review (some do paragraph comments, others do 'code review' style line edits) and the process is open.

We encourage authors and reviewers to work together iteratively to make each others papers the best they can be. Combine the best principles of open source development and academic publication.

These dates are the

  • Sept 1st - Initial PR with title, abstract, and authors
  • Nov 15th - Initial submissions
  • Nov 22th - Reviewers assigned
  • Dec 30th - Reviews due
  • Dec 30th- Jan 31st: Authors revised papers based on reviews
  • Feb 1th - Submission for publication

General Guidelines

  • All figures and tables should have captions.
  • License conditions on images and figures must be respected (Creative Commons, etc.).
  • Code snippets should be formatted to fit inside a single column without overflow.
  • Avoid custom LaTeX markup where possible.

Review Criteria

Please follow the included review criteria. Suggestions and amendments to these review criteria are enthusiastically welcomed via discussion or pull request.

Other markup

Please refer to the example paper in papers/00_vanderwalt for examples of how to:

  • Label figures, equations and tables
  • Use math markup
  • Include code snippets

Requirements

  • IEEETran (often packaged as texlive-publishers, or download from CTAN) LaTeX class
  • AMSmath LaTeX classes (included in most LaTeX distributions)
  • alphaurl (often packaged as texlive-bibtex-extra, or download from CTAN) urlbst BibTeX style
  • docutils 0.8 or later (easy_install docutils)
  • pygments for code highlighting (easy_install pygments)
  • Due to a bug in the Debian packaging of pdfannotextractor, you may have to execute pdfannotextractor --install to fetch the PDFBox library.

On Debian-like distributions:

sudo apt-get install python-docutils texlive-latex-base texlive-publishers \
                     texlive-latex-extra texlive-fonts-recommended \
                     texlive-bibtex-extra

Note you will still need to install docutils with easy-install or pip even on a Debian system.

On Fedora, the package names are slightly different:

su -c `dnf install python-docutils texlive-collection-basic texlive-collection-fontsrecommended texlive-collection-latex texlive-collection-latexrecommended texlive-collection-latexextra texlive-collection-publishers texlive-collection-bibtexextra`

Build Server

To be added

For organizers

To build the whole proceedings, see the Makefile in the publisher directory.

Credit

This repo was lovingly copied from the excellent scipy-proceedings. It retains the BSD license from that project and uses the same license for all contributions.