<div dir="ltr"><br><div class="gmail_extra"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
And as a sidenote, I wanted to bring this up here before the sprint<br>
today -- what about getting rid of the Orientation and the workshop<br>
materials in the 2.6 docs?  I think they're both well-covered by other<br>
items, or out of date.<br>
<div class="im"></div></blockquote><div><br></div><div>I'm +1 on this.  I think they're somewhat outdated at this point, and I don't imagine too many people continue (or should continue) to use them.</div><div>

<br></div><div>Cameron</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im">> -Nathan<br></div><div class="HOEnZb"><div class="h5">
><br>
><br>
> On Sat, Oct 26, 2013 at 5:58 PM, Elizabeth Tasker<br>
> <<a href="mailto:tasker@astro1.sci.hokudai.ac.jp">tasker@astro1.sci.hokudai.ac.jp</a>> wrote:<br>
>><br>
>> why not flip it around and have the script be the standard, compact way of<br>
>> viewing the data, but one can click on a link to take the user to a notebook<br>
>> that they can look at, and which can be downloaded?<br>
>><br>
>><br>
>> I'm +1 on this idea. When I work with my students during our meeting, we<br>
>> use python notebooks to explore the data, but when they or I do serious<br>
>> analysis, we use scripts.<br>
>><br>
>> Given this is the main way of using yt, I think there's a lot of benefit<br>
>> in demonstrating it as the standard and keeping the python notebooks as a<br>
>> teaching tool that one could click on to view. (Rather like the 'hint'<br>
>> system in online homework systems!).<br>
>><br>
>> Elizabeth<br>
>><br>
>><br>
>><br>
>> On Oct 27, 2013, at 5:08 AM, Brian O'Shea <<a href="mailto:bwoshea@gmail.com">bwoshea@gmail.com</a>> wrote:<br>
>><br>
>> Hi folks,<br>
>><br>
>> I'm sorry for not responding to Nathan and Cameron's emails from a couple<br>
>> of days ago in a timely fashion.<br>
>><br>
>> I believe that people who use yt to do data analysis in a production<br>
>> setting are primarily using scripts, as Britton said.  This is certainly<br>
>> true in my own research group, and I think generally true when people are<br>
>> doing batch analysis of large datasets (and/or lots of datasets) on<br>
>> supercomputers.  If the cookbook is truly meant to help users that are new<br>
>> to yt, it makes sense to present the cookbook code in the manner that most<br>
>> closely approximates how a new user will actually use it, so presenting the<br>
>> code as scripts in the cookbook makes the most sense to me.  Also, the<br>
>> current implementation of the cookbook is relatively compact, so it's easy<br>
>> to scroll through and extract what one needs, which is useful for the OTHER<br>
>> use of the cookbook, which is for more advanced users to quickly zip through<br>
>> and remind themselves of how the heck a piece of functionality works.  Using<br>
>> iPython notebooks would make the cookbook much longer, or force us to break<br>
>> it up into a bunch of segments.  Either way, it would also be harder to<br>
>> quickly parse through because the actual commands the user cares about are<br>
>> embedded inside quite a bit of extraneous (for this purpose) text.  I'm<br>
>> concerned that this mailing list's enthusiasm for the new, shiny thing,<br>
>> while commendable in many ways, is driving us away from the original<br>
>> purposes of the cookbook, at least as I understand them.<br>
>><br>
>> That said, I do think that iPython notebooks are very cool, and I intend<br>
>> to use them as a teaching tool in a class I'm teaching next semester. It's<br>
>> also pretty clear which way the wind is blowing on this mailing list, so<br>
>> putting iPython notebooks into the cookbook in some way appears to be<br>
>> inevitable.  So, why not flip it around and have the script be the standard,<br>
>> compact way of viewing the data, but one can click on a link to take the<br>
>> user to a notebook that they can look at, and which can be downloaded?  That<br>
>> allows the cookbook to be relatively easy to parse, and also lets people who<br>
>> want to see the notebooks do so.<br>
>><br>
>> --Brian (though possibly "Grampa Brian" is a more appropriate signoff,<br>
>> given the tone of my email)<br>
>><br>
>><br>
>> On Sat, Oct 26, 2013 at 12:09 PM, Britton Smith <<a href="mailto:brittonsmith@gmail.com">brittonsmith@gmail.com</a>><br>
>> wrote:<br>
>>><br>
>>> There seems to be enough utility in having both the notebooks and at<br>
>>> least some way of downloading pure python scripts.  On the one hand, the<br>
>>> notebooks are illustrative for both yt usage and for learning ipython<br>
>>> notebooks themselves.  As a teaching tool, they seem great.  On the other, I<br>
>>> think the primary usage of yt for analysis is through scripting and we<br>
>>> should try to preserve that notion and make these available as seeds for new<br>
>>> users looking to build their own scripts.  I think that presenting the<br>
>>> recipes with the notebook, but with a button to download as a script nearby,<br>
>>> would be an option that satisfies everyone.<br>
>>><br>
>>> Britton<br>
>>><br>
>>><br>
>>> On Thu, Oct 24, 2013 at 9:54 PM, Chris Malone <<a href="mailto:chris.m.malone@gmail.com">chris.m.malone@gmail.com</a>><br>
>>> wrote:<br>
>>>><br>
>>>> I'm +1 on this, with the possibility of providing also just the .py<br>
>>>> files from nbconvert for those that won't/can't use notebooks.<br>
>>>><br>
>>>> Chris<br>
>>>><br>
>>>><br>
>>>> On Thu, Oct 24, 2013 at 12:28 PM, Sam Skillman <<a href="mailto:samskillman@gmail.com">samskillman@gmail.com</a>><br>
>>>> wrote:<br>
>>>>><br>
>>>>> Hi all,<br>
>>>>><br>
>>>>> I think if we don't take this opportunity to use notebooks during this<br>
>>>>> major update to the documentation, we'll be kicking ourselves in about a<br>
>>>>> year for missing it.  I'd like to voice my support for the following layout:<br>
>>>>><br>
>>>>> 1) Write the cookbook examples in a notebook, annotating it with<br>
>>>>> comments and reasoning in markdown cells. Use some amount of conventions for<br>
>>>>> data loading so that with minimal work users could change the path to the<br>
>>>>> data and run themselves.<br>
>>>>> 2) Display the notebooks in the docs<br>
>>>>> 3) Allow for download of both a stripped down (no images included)<br>
>>>>> .ipynb and nbconverted script.<br>
>>>>><br>
>>>>> The neat thing is that now you have all these .ipynb files in the doc<br>
>>>>> repo. It would be stupid simple to then show people how to go to that<br>
>>>>> folder, launch yt notebook, you can then interactively execute the examples<br>
>>>>> after pointing to the data locations.  This would be really really nice in<br>
>>>>> my opinion.<br>
>>>>><br>
>>>>> Cheers,<br>
>>>>> Sam<br>
>>>>><br>
>>>>><br>
>>>>><br>
>>>>> On Wed, Oct 23, 2013 at 10:02 PM, Elizabeth Tasker<br>
>>>>> <<a href="mailto:tasker@astro1.sci.hokudai.ac.jp">tasker@astro1.sci.hokudai.ac.jp</a>> wrote:<br>
>>>>>><br>
>>>>>> Hi everyone,<br>
>>>>>><br>
>>>>>> I agree with Brian. I've only recently discovered python notebooks and<br>
>>>>>> I love them for my own analysis and when I'm looking at data together with<br>
>>>>>> my students and we're exploring data sets, but I feel they are unnecessary<br>
>>>>>> cumbersome for code examples.<br>
>>>>>><br>
>>>>>> Most of the cookbook snippets have only one simple product (image,<br>
>>>>>> plot etc), so you don't gain a great deal by showing the results from each<br>
>>>>>> line in the notebook.<br>
>>>>>><br>
>>>>>> Additionally, however great notebooks are, they're not as handy for<br>
>>>>>> tasks that you need to perform repeatedly or for writing full length<br>
>>>>>> analysis scripts. In my opinion, using yt as a front end to more detailed<br>
>>>>>> analysis is one of its major strengths. If you take away the cookbook<br>
>>>>>> scripts, we lack examples of yt in python programs.<br>
>>>>>><br>
>>>>>> The notebooks are also not quite as easy to use as a downloaded code<br>
>>>>>> snippet.<br>
>>>>>><br>
>>>>>> Elizabeth<br>
>>>>>><br>
>>>>>><br>
>>>>>><br>
>>>>>> On Oct 23, 2013, at 7:23 PM, Brian O'Shea <<a href="mailto:bwoshea@gmail.com">bwoshea@gmail.com</a>> wrote:<br>
>>>>>><br>
>>>>>> Hi Cameron,<br>
>>>>>><br>
>>>>>> For what it's worth, as a user of yt I find the current cookbook<br>
>>>>>> format to be incredibly useful.  I don't think notebooks would add to the<br>
>>>>>> utility - it's easy enough for me to download the script and load it into a<br>
>>>>>> notebook on my own machine if that's what I want to do.  It definitely seems<br>
>>>>>> that the challenges (and possible downsides) substantially outweigh the<br>
>>>>>> benefits, at least for me and my usage patterns.<br>
>>>>>><br>
>>>>>> --Brian<br>
>>>>>><br>
>>>>>><br>
>>>>>><br>
>>>>>> On Tue, Oct 22, 2013 at 4:13 PM, Cameron Hummels <<a href="mailto:chummels@gmail.com">chummels@gmail.com</a>><br>
>>>>>> wrote:<br>
>>>>>>><br>
>>>>>>> Hey everyone,<br>
>>>>>>><br>
>>>>>>> The documentation sprint is next Monday and Tuesday for those of you<br>
>>>>>>> who want to participate.  I'll send out another email regarding that in the<br>
>>>>>>> next day or so.<br>
>>>>>>><br>
>>>>>>> In preparation for that, though, I wanted to request input from the<br>
>>>>>>> developer community on something related to the docs.<br>
>>>>>>><br>
>>>>>>> Right now, the cookbook page contains a lot of recipes for doing<br>
>>>>>>> various things, and I think it is hugely beneficial to the community to<br>
>>>>>>> maintain this (I personally use this page a lot too!).  However, with the<br>
>>>>>>> advent of ipython notebooks over the last year, we are faced with a<br>
>>>>>>> question: should we move toward incorporating more notebooks into our<br>
>>>>>>> documentation, and specifically, do you we want to transfer the existing<br>
>>>>>>> cookbook to a series of notebooks for each task?<br>
>>>>>>><br>
>>>>>>> Benefits:<br>
>>>>>>> --Portability: users can download an entire notebook for both viewing<br>
>>>>>>> how it should work as well as being able to execute it locally on their own<br>
>>>>>>> datasets<br>
>>>>>>> --Illustrative: Interim steps in a cookbook can produce output that<br>
>>>>>>> can show up inside the notebook, instead of being a single script which<br>
>>>>>>> generates an image/output at the end (as is the case in the current<br>
>>>>>>> paradigm)<br>
>>>>>>> --Narrative: notebooks provide more space for narrating each step,<br>
>>>>>>> instead of confining any narrative to comments in the recipe itself<br>
>>>>>>><br>
>>>>>>> Disadvantages:<br>
>>>>>>> --Work: it is going to take a decent amount of work to move all of<br>
>>>>>>> the recipes over from the existing cookbook to individual notebooks<br>
>>>>>>> --Bulking of repo: In the current paradigm, images associated with<br>
>>>>>>> each recipe are generated dynamically on the server by executing each<br>
>>>>>>> script, thereby minimizing the number of files that need to be tracked by<br>
>>>>>>> mercurial.  By moving to a notebook with images that are embedded in each<br>
>>>>>>> notebook, we'd potentially increase the footprint of the repository<br>
>>>>>>> substantially, especially if there were frequent updates of individual<br>
>>>>>>> recipes.<br>
>>>>>>><br>
>>>>>>> I also like the yt bootcamp notebooks that Matt put together a year<br>
>>>>>>> ago.  I think they are great for getting new users up to speed on how to use<br>
>>>>>>> various aspects of the code.  Perhaps this notebook could make its way into<br>
>>>>>>> the beginning of the cookbook for a more streamlined approach to the<br>
>>>>>>> documentation?<br>
>>>>>>><br>
>>>>>>> So now is your chance to vote:<br>
>>>>>>><br>
>>>>>>> Move cookbook to ipython notebooks? +/- 0-1?<br>
>>>>>>><br>
>>>>>>> Move yt bootcamp to cookbook? +/- 0-1?<br>
>>>>>>><br>
>>>>>>> Comments?  Suggestions?<br>
>>>>>>><br>
>>>>>>> Cameron<br>
>>>>>>><br>
>>>>>>> --<br>
>>>>>>> Cameron Hummels<br>
>>>>>>> Postdoctoral Researcher<br>
>>>>>>> Steward Observatory<br>
>>>>>>> University of Arizona<br>
>>>>>>> <a href="http://chummels.org" target="_blank">http://chummels.org</a><br>
>>>>>>><br>
>>>>>>> _______________________________________________<br>
>>>>>>> yt-dev mailing list<br>
>>>>>>> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
>>>>>>> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
>>>>>>><br>
>>>>>><br>
>>>>>> _______________________________________________<br>
>>>>>> yt-dev mailing list<br>
>>>>>> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
>>>>>> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
>>>>>><br>
>>>>>><br>
>>>>>><br>
>>>>>> _______________________________________________<br>
>>>>>> yt-dev mailing list<br>
>>>>>> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
>>>>>> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
>>>>>><br>
>>>>><br>
>>>>><br>
>>>>> _______________________________________________<br>
>>>>> yt-dev mailing list<br>
>>>>> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
>>>>> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
>>>>><br>
>>>><br>
>>>><br>
>>>> _______________________________________________<br>
>>>> yt-dev mailing list<br>
>>>> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
>>>> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
>>>><br>
>>><br>
>>><br>
>>> _______________________________________________<br>
>>> yt-dev mailing list<br>
>>> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
>>> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
>>><br>
>><br>
>> _______________________________________________<br>
>> yt-dev mailing list<br>
>> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
>> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
>><br>
>><br>
>><br>
>> _______________________________________________<br>
>> yt-dev mailing list<br>
>> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
>> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
>><br>
><br>
><br>
> _______________________________________________<br>
> yt-dev mailing list<br>
> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
><br>
_______________________________________________<br>
yt-dev mailing list<br>
<a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
<a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
</div></div></blockquote></div><br><br clear="all"><div><br></div>-- <br>Cameron Hummels<div>Postdoctoral Researcher</div><div>Steward Observatory</div><div>University of Arizona</div><div><a href="http://chummels.org" target="_blank">http://chummels.org</a></div>


</div></div>