Code Monkey home page Code Monkey logo

scipy_proceedings's Introduction

SciPy Proceedings

Instructions for Reviewers

  • Click on the Pull Requests Tab and browse to find the papers assigned to you
  • After reading the paper, you can start the review conversation by simply commenting on the paper, taking into consideration this set of 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 4th at 18:00 PST.

Instructions for Authors

Submissions must be received by May 30th at 23:59 PST, but modifications are allowed during the open review period which ends July 5th at 18:00 PST. Submissions are considered received once a Pull Request has been opened following the procedure outlines below.

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

  • Fork the scipy_proceedings repository on GitHub.

  • Check out the 2016 branch (git checkout 2016).

  • 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 2016, and the pull-request should be against our 2016 branch.

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

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

A small subcommittee of the SciPy 2016 organizing committee has created this set of suggested review criteria to help guide authors and reviewers alike. 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)
  • docutils 0.8 or later (easy_install docutils)
  • pygments for code highlighting (easy_install pygments)

On Debian-like distributions:

sudo apt-get install python-docutils texlive-latex-base texlive-publishers \
                     texlive-latex-extra texlive-fonts-recommended
  • Due to a bug in the Debian packaging of pdfannotextractor, you may have to execute pdfannotextractor --install to fetch the PDFBox library.

Build Server

Thanks to the great and wonderful Katy Huff, there is a server online building the open pull requests here. You may be able to pull a built PDF for review from there.

For organizers

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

scipy_proceedings's People

Contributors

bmcfee avatar breuleux avatar dotsdl avatar dwf avatar gdesjardins avatar jaberg avatar jarrodmillman avatar jhmeinke avatar jjhelmus avatar jseabold avatar kadambarid avatar kain88-de avatar katyhuff avatar kcarnold avatar koverholt avatar kyleniemeyer avatar lamblin avatar madhusudancs avatar minrk avatar mmckerns avatar mpacer avatar orbeckst avatar pdebuyl avatar pierre-haessig avatar prabhuramachandran avatar sarostru avatar sseyler avatar stefanv avatar taldcroft avatar wesm avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

scipy_proceedings's Issues

acknowledgements

@datreant/coredevs โ€“ please add acknowledgements to the draft (e.g. any grants that you get paid on). Double-check with your PI if necessary. It is often very important that all grant numbers are listed because this is one way in which successes of grants are measured.

(We can fix this in review but it's good to be complete from the start.)

"Introspecting a Treant's Tree" example could use more character

At the moment I've included a brief example of how the filesystem manipulation machinery built into Treants can be used with other packages, such as storing a pandas DataFrame and examining the file. This uses a randomly-generated DataFrame at the moment, but we could do better with a small DataFrame that has, e.g. tree nut data or bark varieties data. Currently the randomly-generated values are too long for the page column, too.

Anyone want to hammer on this? It's pretty isolated, but can be fun.

Topics for datreant proceedings paper

Over the course of today and the rest of the weekend I'll be pulling together the proceedings paper for datreant. I have a basic skeleton together already on which I'll be nucleating the content, but is there anything in particular you think should be showcased?

Similar to MDAnalysis#2:

Note that this paper should not be an in-depth view of datreant but rather a big picture "advertisement". Primarily, it should introduce the library to a wider audience and quickly allow a reader to answer the questions

  • Is datreant applicable to my problems?
  • Should I (or one of my students) give it a try?
  • What are advantages of using datreant? What might I be able to do with it that would be difficult or impossible otherwise?

Progress on main text

I am hammering on the main text now, and this issue is meant to serve as a discussion point for it as we move forward. The manuscript is coming along, but seeing as how time is short I'm drafting it quickly.

If you have a moment, have a look at what's there, and make it know here what you do/don't like about it so that we can quickly iterate it out. Thanks!

PRs are also welcome if the spirit moves you. I am happy to be the one to handle merge conflicts, so don't worry about falling behind.

Adding citations

We need to add citations where necessary for other Python packages. This is something I'd be happy for someone else to take on while I focus on building out content.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.