https://github.com/thechymera/opr.opr-concepts-guidelines

OPR - Concepts and Guidelines for an “Open Publication Revision” System
https://github.com/thechymera/opr.opr-concepts-guidelines

Last synced: 7 days ago
JSON representation

OPR - Concepts and Guidelines for an “Open Publication Revision” System

• Host: GitHub
• URL: https://github.com/thechymera/opr.opr-concepts-guidelines
• Owner: TheChymera
• License: other
• Created: 2013-07-11T14:43:36.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-07-11T16:07:40.000Z (over 11 years ago)
• Last Synced: 2024-11-16T19:42:56.033Z (2 months ago)
• Language: Python
• Size: 172 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# SciPy Proceedings

## Paper Format

Papers are formatted using reStructuredText and the compiled version should be

no longer than 7 pages, including figures.  Here are the steps to produce a

paper:

- Fork the [scipy_proceedings](https://github.com/scipy/scipy_proceedings)

  repository on GitHub.

- Check out the 2013 branch (``git checkout 2013``).

- An example paper is provided in ``papers/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 ensure that you file against the correct branch**--your branch should

  be named 2013, and the pull-request should be against our 2013 branch.

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

Pull requests are to be submitted by **May 19th**, but modifications are

allowed during the review period until June 14th.

## 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.

## 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](http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/) LaTeX

   class

 - AMSmath LaTeX classes (included in most LaTeX distributions)

 - `docutils` 0.8 or later (``easy_install docutils``)

 - `pygments` for code highlighting (``easy_install pygments``)