Tutorial cleanup - Githubissues

michaelcdevin commented 2 months ago

Description

This is a major PR with various edits of the four tutorials included in the examples directory. This PR includes the following changes:

Tutorial 1 is substantially reworked to make it easier to follow
- Part 1 is reordered to define the wave conditions, then the WEC object, then the objective function in sequence. Currently, Tutorial 1 starts defining the WEC object, switches to defining the wave condition, then goes back to the WEC object, which can be difficult to follow.
- More details are added about some WecOptTool fundamentals that could be confusing to new users (or at least were confusing to me!)
- Fixes #293
Changed the plot size and path lengths of the Sankey diagram in Tutorial 4 so the text is not overlapping
Adjusted markdown to make equations and lists appear correctly, fixing #320
Changed colorcycles and colormaps in Tutorials 1 and 2 to be colorblind-friendly
Added more explanation in a few spots where the process being taken was not sufficiently clear
Added more links back in following #287
Split up markdown so each sentence is a separate line to make git diff easier to read in the future (this was done occasionally before, but inconsistently)
Made various editorial changes (word and syntax adjustments, reordering text to improve sentence readability, changing paragraphs into list where appropriate, adding emphasis to important points, adding consistent voice across tutorials) to improve general readability

[x] Authors read the contribution guidelines
[x] The pull request is from an issue branch (not main) on your fork, to the main branch in WecOptTool.
[x] The authors have given the admins edit access
[x] All changes adhere to the style guide including PEP8, Docstrings, and Type Hints.
[x] Modified the documentation if applicable
[ ] All tests pass
[x] Reference or close any relevant issues