Skip to content

Commit f2ee830

Browse files
aterrelaterrel
committed
Adding modified files from scipy-conference/scipy_proceedings.
1 parent 7706076 commit f2ee830

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+5475
-2
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
output
2+
_build
3+
*.pyc
4+
*~

‎LICENSE.txt

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Copyright (c) 2016 PyData Cookbook Authors.
2+
All rights reserved.
3+
4+
The majority of files are adapted from the scipy-proceedings project and are
5+
6+
Copyright (c) 2010-2011 SciPy Developers.
7+
All rights reserved.
8+
9+
The files code_block.py, rstmath.py and sphinx_highlight.py are
10+
adapted from the Sphinx project and are
11+
12+
Copyright (c) 2007-2010 by the Sphinx team (see http://sphinx.pocoo.org).
13+
14+
Modifications to rstmath.py are
15+
16+
Copyright (c) 2010 Marcin Cieslik <mpc4p at virginia.edu>
17+
18+
19+
The following BSD license holds for all the above code:
20+
21+
Redistribution and use in source and binary forms, with or without
22+
modification, are permitted provided that the following conditions are met:
23+
24+
* Redistributions of source code must retain the above copyright notice,
25+
this list of conditions and the following disclaimer.
26+
* Redistributions in binary form must reproduce the above copyright
27+
notice, this list of conditions and the following disclaimer in the
28+
documentation and/or other materials provided with the
29+
distribution.
30+
31+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
32+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
33+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34+
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
35+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
37+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
39+
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
40+
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
41+
DAMAGE.

‎README.md

+131-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,131 @@
1-
# pydata-cookbook
2-
PyData Coobook Project
1+
# PyData Cookbook
2+
3+
## Instructions for Reviewers
4+
5+
- Click on the Pull Requests Tab and browse to find the papers assigned to you
6+
- After reading the paper, you can start the review conversation by simply commenting
7+
on the paper, taking into consideration
8+
[this set of suggested review criteria](https://github.com/scipy-conference/scipy_proceedings/blob/master/review_criteria.md).
9+
- Authors will then respond to the comments and/or modify the paper to address the comments.
10+
- This will begin an iterative review process where authors and reviewers can discuss the
11+
evolving submission.
12+
- Reviewers may also apply one of the labels 'needs-more-review', 'pending-comment', or
13+
'unready' to flag the current state of the review process.
14+
- Only once a reviewer is satisfied that the review process is complete and the submission should
15+
be accepted to the proceedings, should they affix the 'ready' label.
16+
- Reviewers should come to a final 'ready', 'unready' decision before **July 10th** at 18:00 PST.
17+
18+
## Instructions for Authors
19+
20+
Submissions must be received by **Nov 15th** at 23:59 PST, but modifications are
21+
allowed during the open review period which ends Dec 15th at 18:00 PST. Submissions are
22+
considered received once a Pull Request has been opened following the procedure
23+
outlines below.
24+
25+
Papers are formatted using reStructuredText and the compiled version should be
26+
no longer than 15 pages, including figures. Here are the steps to produce a
27+
paper:
28+
29+
- Fork the
30+
[pydata-cookbook](https://github.com/pydata/pydata-cookbook)
31+
repository on GitHub.
32+
33+
- An example paper is provided in ``papers/00_vanderwalt``. Create a new
34+
directory ``papers/firstname_surname``, copy the example paper into it, and
35+
modify to your liking.
36+
37+
- Run ``./make_paper.sh papers/firstname_surname`` to compile your paper to
38+
PDF (requires LaTeX, docutils, Python--see below). The output appears in
39+
``output/firstname_surname/paper.pdf``.
40+
41+
- Once you are ready to submit your paper, file a pull request on GitHub.
42+
43+
- Please do not modify any files outside of your paper directory.
44+
45+
## Schedule Summary
46+
47+
Authors may make changes to their submissions throughout the review process.
48+
49+
There are many different styles of review (some do paragraph comments, others
50+
do 'code review' style line edits) and the process is open.
51+
52+
We encourage authors and reviewers to work together iteratively to make each
53+
others papers the best they can be.
54+
Combine the best principles of open source development and academic publication.
55+
56+
These dates are the
57+
58+
- Nov 15th - Initial submissions
59+
- Nov 22th - Reviewers assigned
60+
- Dec 30th - Reviews due
61+
- Dec 30th- Jan 31st: Authors revised papers based on reviews
62+
- Feb 1th - Submission for publication
63+
64+
## General Guidelines
65+
66+
- All figures and tables should have captions.
67+
- License conditions on images and figures must be respected (Creative Commons,
68+
etc.).
69+
- Code snippets should be formatted to fit inside a single column without
70+
overflow.
71+
- Avoid custom LaTeX markup where possible.
72+
73+
## Review Criteria
74+
75+
A small subcommittee of the SciPy 2016 organizing committee has created [this
76+
set of suggested review
77+
criteria](https://github.com/pydata/pydata-cookbook/blob/master/review_criteria.md)
78+
to help guide authors and reviewers alike. Suggestions and amendments to these
79+
review criteria are enthusiastically welcomed via discussion or pull request.
80+
81+
## Other markup
82+
83+
Please refer to the example paper in ``papers/00_vanderwalt`` for
84+
examples of how to:
85+
86+
- Label figures, equations and tables
87+
- Use math markup
88+
- Include code snippets
89+
90+
## Requirements
91+
92+
- IEEETran (often packaged as ``texlive-publishers``, or download from
93+
[CTAN](http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/)) LaTeX
94+
class
95+
- AMSmath LaTeX classes (included in most LaTeX distributions)
96+
- alphaurl (often packaged as ``texlive-bibtex-extra``, or download from
97+
[CTAN](https://www.ctan.org/pkg/urlbst)) urlbst BibTeX style
98+
- `docutils` 0.8 or later (``easy_install docutils``)
99+
- `pygments` for code highlighting (``easy_install pygments``)
100+
- Due to a bug in the Debian packaging of ``pdfannotextractor``, you may have
101+
to execute ``pdfannotextractor --install`` to fetch the PDFBox library.
102+
103+
On Debian-like distributions:
104+
105+
```
106+
sudo apt-get install python-docutils texlive-latex-base texlive-publishers \
107+
texlive-latex-extra texlive-fonts-recommended \
108+
texlive-bibtex-extra
109+
```
110+
111+
Note you will still need to install `docutils` with `easy-install` or `pip` even on a Debian system.
112+
113+
On Fedora, the package names are slightly different
114+
115+
```
116+
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`
117+
```
118+
119+
## Build Server
120+
121+
**To be added**
122+
123+
## For organizers
124+
125+
To build the whole proceedings, see the Makefile in the publisher directory.
126+
127+
128+
## Credit
129+
130+
This repo was lovingly copied from the excellent [scipy-proceedings](https://github.com/scipy-conference/scipy_proceedings).
131+
It retains the BSD license from that project and uses the same license for all contributions.

‎make_paper.sh

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#!/bin/bash
2+
3+
DIR=$1
4+
5+
if [[ ! -d $DIR ]]; then
6+
echo "Usage: make_paper.sh source_dir"
7+
exit -1
8+
fi
9+
10+
python publisher/build_paper.py $DIR
11+
if [ "$?" -ne "0" ]; then
12+
echo "Error building paper $DIR. Aborting."
13+
exit 1
14+
fi
15+
16+
#cd $OUTDIR
17+
#$TEX2PDF > /dev/null && $TEX2PDF | (python $WD/publisher/page_count.py)

0 commit comments

Comments
 (0)