Initial documentation in the Jupyter Book

[emiliom]

Draft outline.

• Introduction
• Installation and setup
• Workflow
  • Describe it conceptually first, briefly, referring to the main objects
  • Brief, core workflow code. Can be a shortened version of the main workflow notebook, and can be composed as a notebook itself. workflow_minimal.ipynb
  • Point to the extended workflow in echopro_workflow.ipynb
    • Map plots and other plots
    • Steps not included in the core workflow page
  • Other areas
    • SemiVariogram widget, interactive generation
    • Kriging mesh generation
    • Transect subsetting and bootstrapping
• Classes and main data structures. Document core classes #113
  • Listing with docstrings as descriptions
  • Highlights, what they do
  • (Geo)DataFrames and their contents
  • Inputs, processed intermediates, and "results"
  • bio_calc object
• Files, inputs/outputs
  • Config files
  • Input files. Add documentation of input files to Jupyter Book #111
  • Output files (reports). Add documentation of export "report" files to Jupyter Book #112
• A separate page can describe each major "results" gdf in detail

[emiliom]

Refer also to Chu's EchoPro program description Google Doc (2/24/2022)

[leewujung]

Closing this now since many items are outdated and the content will be covered in the next month or so along with the refactoring work in v0.4.X.