[Yt-dev] yt-1.5 documentation?

[Britton Smith]

There is no formal documentation on the halo profiler, or the light cone, or
most of the things I've contributed.  However, I've committed sample running
scripts and parameter files for everything to the examples directory.  At
least for the halo profiler, all of the functionality should be displayed in
sample scripts.  Some more documentation may be in order, but that should
explain how to use it.

Britton

On Sat, Jan 24, 2009 at 11:34 AM, Matthew Turk <matthewturk at gmail.com>wrote:

> I think this is a great idea.  I think there's some great stuff that
> needs to be documented.  I'd prefer that we write it ultimately up in
> a Sphinx format; prototyping on the Wiki is fine, if y'all would
> rather not dive into Sphinx.  I don't mind converting it back.
>
> There are a few documentation tickets open from 1.0 that were for a
> now-unlikely 1.1 release.  http://yt.enzotools.org/report/11  These
> are all related to things like sample images and cross-references.  I
> dropped the ball there.
>
> Britton gave me notes on the documentation some time ago -- I have to
> confess I dropped the ball on those, too.
>
> I'll set up the repo to start including documentation in the trunk,
> and then send an outline of what I think should be done...  Definitely
> not assignments.  But suggestions.  We've made a lot of progress and I
> think we're a lot closer to being able to push this thing out the door
> than I thought.
>
> -Matt
>
> PS I'm sending a paper draft to collaborators this morning; I'll be
> back online this afternoon.
>
> On Sat, Jan 24, 2009 at 10:21 AM, Stephen Skory <stephenskory at yahoo.com>
> wrote:
> > All,
> >
> > I know Matt has delayed formally releasing and promoting 1.5 due to his
> graduation, but I'm wondering if we should start documenting some of the new
> things in 1.5? For example, I think I might have use for Britton's halo
> profiling tools right now, but there's no documentation how to use it
> (although I'm sure I can figure it out by myself, I'm making a point here).
> Similarly, I have intelligence to contribute about running parallel HOP
> which isn't documentated anywhere, and Dave has added/created some scripts
> of his own for yt which I'm aware of but don't know anything about.
> >
> > I don't know if I want to debate the pros and cons of Sphinx and the Trac
> wiki, but I am just wondering what people think we should be doing about
> this? 1.5 will be promoted eventually and these documents need to be
> written.
> >
> >  _______________________________________________________
> > sskory at physics.ucsd.edu           o__  Stephen Skory
> > http://physics.ucsd.edu/~sskory/ <http://physics.ucsd.edu/%7Esskory/>_.>/ _Graduate Student
> > ________________________________(_)_\(_)_______________
> >
> > _______________________________________________
> > Yt-dev mailing list
> > Yt-dev at lists.spacepope.org
> > http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
> >
> _______________________________________________
> Yt-dev mailing list
> Yt-dev at lists.spacepope.org
> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.spacepope.org/pipermail/yt-dev-spacepope.org/attachments/20090124/b004c618/attachment.html>