[AstroPy] Best practices for Python sample code in journal articles

[Kevin Gullikson]

Leo,

I just submitted a paper <http://arxiv.org/abs/1604.06456> that links to my
github <https://github.com/kgullikson88/BinaryInference> with a bunch of
jupyter notebooks with the analysis. The journal people mentioned that they
are actually working on some way to host the notebooks on their website or
something, but for now I think linking to your github is probably the way
to go. If you want to show code in the actual article, I've heard minted is
a good option but never used it myself.

On Thu, Apr 28, 2016 at 9:13 AM Jo Bovy <bovy at astro.utoronto.ca> wrote:

> Hi Leo,
>
> I'm not sure this is exactly what you're looking for, but in my paper
> <http://adsabs.harvard.edu/abs/2015ApJS..216...29B> on galpy, I used
> minted <https://github.com/gpoore/minted> to typeset Python code as
> figures (and some inline). The only downside is that arXiv doesn't allow
> this, because you need to run latex with -shell-escape (I got my paper on
> arXiv in a very hacky way). ApJS didn't have any problems with getting this
> in print.
>
> Best,
>
> Jo
>
> On Thu, Apr 28, 2016 at 10:00 AM, Singer, Leo P. (GSFC-661.0)[UNIVERSITIES
> SPACE RESEARCH ASSOCIATION] <leo.p.singer at nasa.gov> wrote:
>
>> Hi,
>>
>> I am working on an ApJ submission that I would like to pair with a
>> supplement paper that contains (among other things) some Astropy-based
>> sample/tutorial Python code to acquaint the reader with an accompanying
>> data release. Are there any established best practices for including Python
>> in journal articles? Should code and output be presented docstring-style or
>> should it look like an IPython session? Does anyone have nice examples of
>> astronomy papers that include supplemental IPython notebooks?
>>
>> If anyone is interested, this is the article and data release:
>> https://arxiv.org/abs/1603.07333
>> http://asd.gsfc.nasa.gov/Leo.Singer/going-the-distance/
>>
>> Cheers,
>> Leo
>>
>>
>> Dr. Leo P. Singer
>> NASA Postdoctoral Program Fellow
>> Goddard Space Flight Center
>> 8800 Greenbelt Rd., B34, Room S239
>> Greenbelt, MD 20771
>> _______________________________________________
>> AstroPy mailing list
>> AstroPy at scipy.org
>> https://mail.scipy.org/mailman/listinfo/astropy
>>
>
> _______________________________________________
> AstroPy mailing list
> AstroPy at scipy.org
> https://mail.scipy.org/mailman/listinfo/astropy
>
-- 
Kevin Gullikson
PhD Candidate
University of Texas Astronomy
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/astropy/attachments/20160428/875c632a/attachment.html>