complete 0.1a1 release documentation

[mmckerns]

The mystic mystic-0.1a1 release is missing some documentation beyond that noted in tickets #18, #19, #20, and #21 (source, epydoc, front page, and tutorials, respectively). A High-level design diagram and a user guide should also be included, although the source+epydoc may serve as the backbone for the user guide.

The license, list of authors/contributors, acknowledgements/funding, and the download tarball itself all need to be added.

[mmckerns]

License note, list of authors, and acknowledgements should be on the wiki front page. Tutorials should be on their own page, and heavily leverage (comments in) existing code. Tutorials should be linked from the front page.

The download tarballs should be linked from the front page and the release page. Same for the user manual (or better called, a reference manual). High-level design diagram can be included in the reference manual.

[mmckerns]

Here's an idea:

The milestone pages provide a relatively nice release summary... by adding a little more wiki content, it could serve as a nice back-of-the box version-specific release page. General information, introduction, and the majority of wiki links would stay on the WikiStart page.

[mmckerns]

transferring leftovers from ticket #18, each minimal solver interface needs source documentation

[mmckerns]

minimal solver interfaces for fmin and fmin_powell added in r120

[mmckerns]

Replying to mmckerns:

minimal solver interfaces for fmin and fmin_powell added in r120

I meant, documentation for fmin & fmin_powell

[mmckerns]

minimal solver interface doc added for diffev in r121

[mmckerns]

added remaining mystic-0.1a1 module and method documentation (except for mystic.forward_model) in r123

[mmckerns]

license and authors added to  http://docs.danse.us/mystic.

Should repeat on wiki.

[mmckerns]

User's guide for mystic-0.1a1 will follow general guidelines as in ticket #27, however will be reduced to a wiki index page with links to the source code for the tutorial examples, and a link to the reference manual. A more robust user's guide is put off until a later release.

[mmckerns]

Transferring leftovers from tickets #20 & #21.

Release content still to do...

Front page content:

• short summary/introduction/vision
• teaser example with some nice pictures
• link to user guide
• link to reference manual
• link to installation instructions
• link to license
• version number & link to distribution
• author/contributor list and contact information
• acknowledgments and funding

Somehow should utilize the specific (milestone) release page. Somehow should integrate the high-level design diagram.

[mmckerns]

High-level design diagram deferred to later release, see ticket #28.

[mmckerns]

committed tutorial examples in r126

[mmckerns]

All front page content added except a teaser example with nice pictures. Example and pictures deferred to a later release, see ticket #31.

Nothing left that hasn't been deferred to other tickets... thus we are done.