Feature: Docs overhaul

[yardasol]

Background and motivation

SaltProc has two thesis and several papers in which it is used, however it does not have a narrative, step=by-step user's guide. What currently exists in the online docs is a bit sparse.

Description of idea

SaltProc should have a user's guide that is narrative, step-by-step, and fully formed.
The docs should also have infomation and references to input and output file structure, publications, and the theory/context of the code.

Implementation details

I predict that we will need to do several things:

• Reorganize the current structure of the docs to make navigation easier when there are more docpages
• Make python notebooks that users can use to run examples quickly and easily
• Make scripts where necessary for pre and post-processing steps
• Specific docpages (in no particular list order, nest order is relevant):
  • File Format Specification
    • Input Files
    • Output Files
• Theory Page
• Publications page
• Dev Guide
  • Style
    • Issues/Feature requests
    • PRs
      • Add comments in template on how users should describe their changes (it should be a bulleted list using nesting where appropriate)
• User's Guide
  • Basics
  • Installing SaltProc
  • Installing depletion code
  • Setting up XS library
  • Creating an input file
  • Creating a dot file
  • Creating a process file
    • Custom and time-dependent extraction efficiencies
  • Running a simulation
    • Geometry switching when keff will drop below 1
  • Processing results

We should also rename doc/src to doc/api.

This feature is too large and requires too much care to be part of the 0.4.0 release.

Potential snags

We may need to modify app.py to enable in-notebook running of the code.

[munkm]

This is an excellent feature request!