Complete the User Guide

[mepcotterell]

The User Guide is currently incomplete. There are a lot of improvements that can be made. This issue will include User Guide enhancements targeted for Scalation Kernel 1.2.0. Another issue will be created (and linked to from here) if and when planned User Guide enhancements are deferred to later releases.

Priority Enhancements

• Convert the User Guide into a notebook (see Convert the User Guide into a notebook #4).

Sections

• Introduction:
  • Need to write one. Currently, the project pages (GitHub and PyPi) serve as introductions. This is not sufficient.
• Creating a ScalaTion Notebook:
  • Include screenshots.
  • Include a simple example.
• Using the ScalaTion Big Data Framework:
  • Provide a brief introduction to ScalaTion and provide links to official documentation.
  • Introduce the example notebooks.
• Basic Plotting:
  • Improve existing examples.
  • Need to add documentation for basic 3D plotting provided by ::plot3d.
• Formatters:
  • Introduce the concept of output formatters.
  • Document ::relation, a formatter command for the Relation class (see Document the ::relation command #5).