Configuration Tutorial

[jillianderson8]

Write Configuration Tutorial

This tutorial should focus on how to read, write, and manage the configuration files that are critical to this package. Some key points:

• We should mention (but not dwell on) that our config files are written in YAML
• This should include a table or well-structured bullets that detail each of the possible fields in the configuration files
• Talk about how to use multiple configuration files and why you might want to
• When we describe the boundaries field, we should also explain how a user could go about determining their source. Note: this will need to be updated with Steven's work on multiple boundaries for different data sources.

[jillianderson8]

I've pushed a draft version of this tutorial (f73c33e).

However, there are somethings that need to revisited before it can be finalized.

• Write the data, bounds, file_map, and Choosing Study Boundaries sections once range-driver has been updated to accept multiple bounds objects. This change will have significant implications on the configuration file format.
• Determine whether the view.columns option is used anywhere in range_driver. If not, remove from our config files & tutorial.
• Visit whether view.tidal should be an option at all. Why not just let users use report_tidal() and throw an error if there isn't tidal data available? Seems redundant to have to specify it.
• Confirm that view.bounds can be used in two ways. Either using center + offsets, or extremes/limits (north, south, east, west).
• Review view.params to determine which of these parameters should actually be specified by the user (e.g. should t2 be specified, or is that just inherent in the calculation of t2?)