<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;"><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;">Current docs build is here: <a href="http://ngoldbaum.net/docs_build/">http://ngoldbaum.net/docs_build/</a></div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;"><br></div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;">Hopefully we will have the automated dev doc builds on yt-project.org working correctly in the next few days and we can stop using one-off docs builds.</div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;"><br></div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;">There are still a number of open issues, many of them pretty low-hanging. I think just a few hours of effort form a couple of people will finish up most of them.</div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;"><br></div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;">Open documentation issues: <a href="https://bitbucket.org/yt_analysis/yt/issues?component=documentation&status=open&status=new">https://bitbucket.org/yt_analysis/yt/issues?component=documentation&status=open&status=new</a></div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;"><br></div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;">Also, if you’re having trouble with the docs build and the new sphinx extensions, please take a look at this page, particularly the last section on quick docs builds: <a href="http://ngoldbaum.net/docs_build/developing/building_the_docs.html">http://ngoldbaum.net/docs_build/developing/building_the_docs.html</a></div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;"><br></div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;">-Nathan</div> <div id="bloop_sign_1383425605754226944"></div> <br><p style="color:#A0A0A8;">On October 30, 2013 at 1:27:22 AM, Cameron Hummels (<a href="mailto://chummels@gmail.com">chummels@gmail.com</a>) wrote:</p> <blockquote type="cite" class="clean_bq"><span><div><div>
<title></title>
<div dir="ltr">
<div>Hey everyone,</div>
<div><br></div>
<div>We finished up the doc sprint today. I think we made
some big improvements to the doc base in the last two days with
help from: Sam Skillman, Geoffrey So, Nathan Goldbaum, John Zuhone,
Jeff Oishi, Britton Smith, Matt Turk, and me. Thanks
everyone! But we're not done with everything yet. By my
tally, everyone still has a task to complete, and there are still
some open tickets on the bitbucket docs issues list. In this
email, I'll try to summarize what we did, what remains to be done,
and what the timeline forward is.</div>
<div><br></div>
<div>First of all, the latest docs exist in my PR here:</div>
<div><a href="https://bitbucket.org/yt_analysis/yt-doc/pull-request/110/updates-to-docs-after-day-one-of-the-doc/" target="_blank">https://bitbucket.org/yt_analysis/yt-doc/pull-request/110/updates-to-docs-after-day-one-of-the-doc/</a><br>
</div>
<div><br></div>
<div>There is a build of this available for viewing here:
</div>
<div><a href="http://green.as.arizona.edu:8080" target="_blank">http://green.as.arizona.edu:8080</a></div>
<div><br></div>
<div>ACCOMPLISHED</div>
<div>--Restructured the doc layout to be more hierarchical, so that
now all of the docs fall into the following categories: install/,
help/, bootcamp/, cookbook/, development/, examine/, visualize/,
analyze/, and reference/.</div>
<div>--Restructured the top-level page to reflect this, resulting
in a much simpler and cleaner starting point.</div>
<div>--Added support for embedded notebooks, embedded executed
scripts, and embedded notebook snippets in the docs which get
executed and built dynamically with the docs.</div>
<div>--Updated what codes are supported in 2.x (removed support for
gadget, ramses and art, since these don't work well in 2.x)</div>
<div>--Updated the installation instructions</div>
<div>--Moved the bootcamp from its own repository into the docs as
the main introduction to the code using embedded notebooks.</div>
<div>--Updated the "How to get help" to be "how to solve problems"
with several suggestions that one can do on their own before
turning to the mailing list.</div>
<div>--Split the cookbook into Example Scripts and Example
Notebooks (longer demonstrations of more complex
functionality).</div>
<div>--Updated the "How to Make Plots" and "Plot Modification"
parts of the visualization docs making extensive use of the new
embedded scripts and embedded notebook snippets. Looks
great!</div>
<div>--Added a section on how to make SZ synthetic observations on
one's datasets using the new embedded notebook</div>
<div>--Getting rid of the old workshop lessons</div>
<div>--Removing the bitbucket wiki, since it contained outdated and
conflicting redundant information from the docs</div>
<div>--Numerous updates and typo fixes</div>
<div><br></div>
<div>YET TO BE FINISHED</div>
<div>(see open documentation issues here: <a href="https://bitbucket.org/yt_analysis/yt/issues?component=documentation&status=open&status=new">https://bitbucket.org/yt_analysis/yt/issues?component=documentation&status=open&status=new</a>
)</div>
<div>--Explain use of CuttingRegion/FieldCuts -- Britton</div>
<div>--Write up ProfilePlot docs -- Britton</div>
<div>--Make PhasePlot work in yt and document it -- Matt and
Britton</div>
<div>--Introduce how to use a notebook -- Nathan</div>
<div>--Update VR docs -- Sam</div>
<div>--Make a VR notebook with a great example -- Sam</div>
<div>--Demonstrate how to bring in arbitrary grid datasets into the
code -- John</div>
<div>--Purge, fix, move dangling links in the code from the
restructure -- Cameron</div>
<div>--Describe how to export to sketchfab -- Matt</div>
<div>--Add section in developer docs on "How to dig into the
source" --Cameron</div>
<div>--Describe how to get the sample datasets and set up test_dir
in config.</div>
<div>--Document how to do VR with two fields (cookbook)</div>
<div>--Update docs for command-line arguments</div>
<div>--Document cosmology units</div>
<div><br></div>
<div>I think we need to finish these things before the release of
2.6. I think if people continue to work on these issues with
the same momentum we've had the last couple of days, we'll get this
finished in the next week. </div>
<div><br></div>
<div>Overall, I think the docs are looking a lot better at this
point. Let us know if you have any additional
comments/suggestions. Thanks again to those of you who put in
a lot of hard work the last couple of days!</div>
<div><br></div>
<div>Cameron</div>
</div>
<div class="gmail_extra"><br>
<br>
<div class="gmail_quote">On Mon, Oct 28, 2013 at 6:16 PM, Cameron
Hummels <span dir="ltr"><<a href="mailto:chummels@gmail.com" target="_blank">chummels@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div dir="ltr">Hey everyone,
<div><br></div>
<div>This is a status update after day one of the doc sprint.
We had a good turnout with Matt Turk, Sam Skillman, John
Zuhone, Jeff Oishi, Nathan Goldbaum, and myself present. We
were able to get a lot done, some synchronously, some
asynchronously, over the course of the day.</div>
<div><br></div>
<div>Work has begun on restructuring the docs to make them more
easily navigable. The front page has been cleaned up to have
a limited number of top-level options for users. The
installation page has been updated. The cookbook repository
has been merged into the docs inline so that new users can view (or
execute) that as their introduction to the functionality of yt.
Minor changes have occurred on the help pages and the
developer pages. Significant effort has gone into making the
docs more succinct and having fewer overlap points (where some
concept is explained more than once). The workshop materials
were removed and many of the former top-level directories (e.g.
advanced) have been split up and redistributed into the other code
directories. A new sample dataset was added to the <a href="http://yt-project.org/data" target="_blank">yt-project.org/data</a> site by Nathan of one of his
high-res isolated galaxy sims--it's almost 3 GB, but it's a
beautiful dataset for demonstrating some cool functionality with
real data.</div>
<div><br></div>
<div><br></div>
<div>CURRENT VERSION OF CODE</div>
<div>I've issued a PR to the yt-doc repo with many of these changes
here: <br></div>
<div><a href="https://bitbucket.org/yt_analysis/yt-doc/pull-request/110/updates-to-docs-after-day-one-of-the-doc/commits" target="_blank">https://bitbucket.org/yt_analysis/yt-doc/pull-request/110/updates-to-docs-after-day-one-of-the-doc/commits</a><br>
</div>
<div><br></div>
<div>You can view this version of the docs looks here (minus the
api docs and the bootcamp renderings):</div>
<div><a href="http://green.as.arizona.edu:8080/" target="_blank">http://green.as.arizona.edu:8080/</a><br></div>
<div><br></div>
<div><br></div>
<div>THREE TIERS OF INTERACTING WITH YT</div>
<div>We seemed to settle on grouping yt functionality into 3 tiers:
visualizing data, analyzing data, and examining data (accessing it
at a low level). Sam Skillman made a cool illustration of
this here: <a href="https://docs.google.com/drawings/d/15aWmO71uHaxjx0qK5bMGxHir9wPI27Cgk-qG03Y00nc/edit" target="_blank">https://docs.google.com/drawings/d/15aWmO71uHaxjx0qK5bMGxHir9wPI27Cgk-qG03Y00nc/edit</a>
. The plan is to have the docs reflect this hierarchy and to
have it show up in the introductory statements on the front
page.</div>
<div><br></div>
<div><br></div>
<div>CURRENT TASKS</div>
<div>--Nathan - Creating a set of notebooks to demonstrate how to
use the plot window and plot modifications effectively. This
will update the entire plotting interface portion of the docs.
Also, create an introduction to how to use notebooks from
scratch.<br></div>
<div>--Jeff & Sam - Writing a notebook demonstrating how to use
it for doing real science, not just merely as a toy.<br></div>
<div>--Cameron - Going over the top-level docs with a fine-toothed
comb looking to update/clarify. Restructuring the hierarchy
of docs.<br></div>
<div>--John - Updating the Athena frontend; Documenting SZ analysis
and particle trajectories in the analysis modules
section.<br></div>
<div>--Matt - Restructuring the hierarchy of docs. Purging
out-of-date information. Picking a new theme for the
docs.<br></div>
<div><br></div>
<div>But there is still a lot left to do. For those of you
who want to participate but don't yet know how you can assist, you
can do a few things. <br></div>
<div>--Look over the docs and see if you find anything that needs
fixing, pruning, updating, etc. Add an issue in the
yt_analysis/yt repo and tag it with documentation, so we know to
fix it. Or create an issue and fix it yourself and PR it.
Really, the docs just need some attention to clean them
up.</div>
<div>--Look at the existing documentation issues on bitbucket.
Address one of them.</div>
<div><br></div>
<div>COOKBOOK<br></div>
<div>I think we settled on a solution to the notebook vs script
debate. Continue to use scripts for the simpler tasks in the
cookbook and use notebooks for more complex examples. Right
now I've split the cookbook into Example Scripts and Example
Notebooks for this task. Tomorrow will be spent adding more
coding examples to both of these subdivisions.</div>
<div><br></div>
<div>
<div>GOALS FOR TOMORROW</div>
<div>Finish restructuring the docs. Add lots more recipes
(both notebook and scripts) to the cookbook. Address more of
the issues from the bb list.</div>
</div>
<div><br></div>
<div>If you want to join us, come by IRC or google+ at 8amPST
tomorrow, and we'll put you to good use.</div>
<div><span class="HOEnZb"><font color="#888888"><br></font></span></div>
<div><span class="HOEnZb"><font color="#888888">Cameron</font></span></div>
</div>
<div class="HOEnZb">
<div class="h5">
<div class="gmail_extra"><br>
<br>
<div class="gmail_quote">On Sat, Oct 26, 2013 at 9:40 AM, Britton
Smith <span dir="ltr"><<a href="mailto:brittonsmith@gmail.com" target="_blank">brittonsmith@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div dir="ltr">Hi Cameron,
<div><br></div>
<div>Thanks for organizing this! This will be very useful I
think. I will be traveling for most of Monday during the time
of the sprint but should be able to participate on Tuesday.
It would be useful if you could provide a short summary of
the events of the first day for those of us who can only join in on
the second day. Thanks again for doing this. See you
all there.</div>
<div><span><font color="#888888"><br></font></span></div>
<div><span><font color="#888888">Britton</font></span></div>
</div>
<div class="gmail_extra"><br>
<br>
<div class="gmail_quote">
<div>
<div>On Thu, Oct 24, 2013 at 2:16 AM, Cameron Hummels <span dir="ltr"><<a href="mailto:chummels@gmail.com" target="_blank">chummels@gmail.com</a>></span> wrote:<br></div>
</div>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div>
<div>
<div dir="ltr">Hey everyone,
<div><br></div>
<div>Next Monday and Tuesday we will be having a documentation
sprint to try to beef up the yt docs (and docstrings) before the
final release of the 2.x branch when development (and
documentation) will switch over to the 3.0 branch. All
developers are welcome to attend/participate for as much time as
they can spare. </div>
<div><br></div>
<div>I know documentation isn't always glamorous, but I think this
will be pretty fun. Furthermore, I think this will be very
beneficial to the community, in that it will be fewer frustrated
users, fewer questions on IRC and the mailing list, and better
understanding for everyone of all the features and functionality of
the codebase!</div>
<div><br></div>
<div>We will be meeting up as a Google + hangout over the course of
those two days, with periodic "check-in" meeting times to make sure
everyone is on the same page (see below for schedule). Yes, I
know it is early for Pacific Coasters on a Monday @ 8am, but you
can meet for a few minutes from your bed without your camera turned
off if need be. We all know that people have meetings and
need to eat and such, so you are not required to be in the G+
hangout constantly. That said, people are encouraged to
remain in the G+ hangout throughout both days for fast turnover
time if they have questions/discussion or want to work on something
new. Documentation tasks will be identified so that attendees
can volunteer for them at the various check-in meetings. This
way, individuals can work on these tasks semi-autonomously.
The various things I think we should aim to accomplish
include:</div>
<div><br></div>
<div>--Add documentation for features that are currently
undocumented in the yt codebase.</div>
<div>--Add documentation for new features from yt 2.5 to present
(in docstrings, cookbooks, and narrative docs as applicable).</div>
<div>--Fulfill the tasks identified in the BitBucket Documentation
Issues List: </div>
<div><a href="https://bitbucket.org/yt_analysis/yt/issues?component=documentation&status=open&status=new" target="_blank">https://bitbucket.org/yt_analysis/yt/issues?component=documentation&status=open&status=new</a><br>
</div>
<div>--Remove outdated information from the docs.</div>
<div>--Pare down multiple locations of how to do individual tasks,
so as to make maintainability easier.</div>
<div>--Fix any typos or mistakes in the content.</div>
<div><br></div>
<div>SCHEDULE</div>
<div>Monday</div>
<div>--8am PST/11am EST: Initial meetup in G+ to discuss the goals
of the sprint and to layout the specific individual tasks which
need to be accomplished. I'll include a template for a
docstrings example, a template for a cookbook example, and an
example of a good narrative docs section. Developers will
choose what task they want to work on. Meeting should take
30-60 minutes.</div>
<div>--11am PST/2pm EST: Status check, and reshuffling of projects
as needed. 15 minutes.<br></div>
<div>--2pm PST/5pm EST: Status check and conclusion for the day. 15
minutes.<br></div>
<div><br></div>
<div>Tuesday</div>
<div>
<div>Same schedule as Monday.</div>
<div><br></div>
<div>WHAT I NEED FROM YOU<br></div>
<div>Please write back to this email saying whether or not you're
going to be attending any/all of the sprint. That way, I can
invite you personally to the google docs hangout to join up.
I may try to make this hangout "on-air" so that it is
recorded, and so if we go above the 10-person limit, those unable
to fit in the hangout can watch it streaming live.</div>
<div><br></div>
<div>Before Monday, please think for a few minutes about things
that you may have noticed in the past that were lacking from the
documentation, but at the time you found them you didn't have time
to fix. If you identify anything, please mark it down as a
documentation task in the bitbucket issue tracker so that we know
to work on it next week: <a href="https://bitbucket.org/yt_analysis/yt/issues?component=documentation&status=open&status=new" target="_blank">https://bitbucket.org/yt_analysis/yt/issues?component=documentation&status=open&status=new</a> .
We will be using this as our main means of tracking what gets
accomplished during the sprint. I encourage you to look at
the docs as well to look for ways they can be improved.</div>
<div><br></div>
<div>Thanks everyone, and I look forward to meeting with you next
week!</div>
<div><span><font color="#888888"><br></font></span></div>
<div><span><font color="#888888"><font color="#222222">Cameron</font></font></span></div>
<div><span><font color="#888888"><font color="#222222"><a href="https://bitbucket.org/yt_analysis/yt/issues?component=documentation&status=open&status=new" target="_blank"><font color="#222222"><br></font></a></font>
-- </font></span></div>
<span><font color="#888888">Cameron Hummels</font></span>
<div><span><font color="#888888">Postdoctoral
Researcher</font></span></div>
<div><span><font color="#888888">Steward
Observatory</font></span></div>
<div><span><font color="#888888">University of
Arizona</font></span></div>
<div><span><font color="#888888"><a href="http://chummels.org" target="_blank">http://chummels.org</a></font></span></div>
</div>
</div>
<br></div>
</div>
<div>_______________________________________________<br>
yt-dev mailing list<br>
<a href="mailto:yt-dev@lists.spacepope.org" target="_blank">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></div>
</blockquote>
</div>
<br></div>
<br>
_______________________________________________<br>
yt-dev mailing list<br>
<a href="mailto:yt-dev@lists.spacepope.org" target="_blank">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></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>
</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>
_______________________________________________
<br>yt-dev mailing list
<br>yt-dev@lists.spacepope.org
<br>http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
<br></div></div></span></blockquote></body></html>