Add documentation for flowsheet examples

[adam-a-a]

None of our flowsheet examples have documentation. This is a considerable gap, and we should add docs for these. Moreover, as we add flowsheets to the GUI (see issue #1117), the need for documentation will increase. I will add an asterisk for those we should prioritize as high priority and a tilde (~) for those we may want to deprioritize. In terms of prioritization, all are still up for discussion though.

EDIT: Tagging people who I think should at the very least should be key points of contact for each:

For March 2024:

• BSM2 flowsheet* @adam-a-a @agarciadiego @MarcusHolly BSM2 Flowsheet Documentation #1263 and BSM2 Flowsheet Documentation Update #1354

For June 2024:

• RO w/ERD* @kurbansitterley Flowsheet documentation for RO w/ ERD #1446
• MD* @ElmiraShamlou add documentation for MD flowsheet #1444
• GAC* @hunterbarber Flowsheet Documentation for GAC #1396
• NaCl Crystallizer * @OOAmusat Flowsheet documentation for NaCl crystallizer #1403
• ED * @lbibl Doc for electrodialysis flowsheet  #1385 Doc for second electrodialysis flowsheet  #1386
• IX Flowsheet documentation for IX #1418
• LSRRO* @adam-a-a @ElmiraShamlou add documentation for LSRRO flowsheet #1450
• MVC* @MarcusHolly @ElmiraShamlou MVC Flowsheet Documentation #1430
• OARO* @luohezhiming Add documentation for OARO flowsheet #1351
• Activate Sludge Model 1 (ASM1) flowsheets @agarciadiego Flowsheets documentation ADM1, ASM1, ASM2d #1376
• ASM2d flowsheets @agarciadiego @adam-a-a @luohezhiming Flowsheets documentation ADM1, ASM1, ASM2d #1376
• ADM1 flowsheet @agarciadiego Flowsheets documentation ADM1, ASM1, ASM2d #1376
• electroN-P flowsheet @luohezhiming
• Municipal Treatment case study (originally from WT3) @kurbansitterley @TimBartholomew
• Seawater RO case study (originally from WT3) @kurbansitterley @TimBartholomew Flowsheet documentation for seawater RO desalination #1425
• 14 zero-order WRRF cases associated with IEDO 2336 @adam-a-a @MarcusHolly @luohezhiming @agarciadiego

---Unit Model Documentation---

• CSTR (mostly a copy of the IDAES CSTR) CSTR and Clarifier Unit Model Documentation #1379
• CSTR with injection (Aeration Tank) CSTR and Clarifier Unit Model Documentation #1379
• Primary Clarifier CSTR and Clarifier Unit Model Documentation #1379
• Secondary Clarifier CSTR and Clarifier Unit Model Documentation #1379

[adam-a-a]

@dangunter highlighted the fact that this effort should also work in coordination with the UI (e.g., being able to point to or pull up model descriptions via the UI)