Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Technical reference improvements #78

Open
7 tasks
adam-a-a opened this issue Oct 3, 2023 · 2 comments
Open
7 tasks

Technical reference improvements #78

adam-a-a opened this issue Oct 3, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation Priority:Normal Normal Priority Issue or PR

Comments

@adam-a-a
Copy link
Contributor

adam-a-a commented Oct 3, 2023

Running to-do list for update technical references in readthedocs:

  • update NTC to NTU in effectiveness of HX equation for VAGMD
  • feed flow rate for MED-TVC should list a valid range in the first table
  • feed flow rate for LT-MED can include "--" in table's valid range
  • remove typo mentioning LTMED in MED-TVC reference (should say MED TVC)
  • MED-TVC: fix table entries for variables including heating steam mass flow and motive steam mass flow
  • Add technical reference for multiperiod VAGMD (can be used for semi-batch or batch)
  • Update vagmd reference title to "vacuum air-gap" instead of "vacuum air-gapped"
@adam-a-a
Copy link
Contributor Author

adam-a-a commented Oct 3, 2023

Nice-to-have running to-do:

  • Add full, more lengthy documentation on LTMED, MEDTVC, and VAGMD in "background" section to provide more background explanation regarding the surrogate models
  • Add custom diagrams for LT-MED, MED-TVC, and VAGMD

@adam-a-a adam-a-a added Priority:Normal Normal Priority Issue or PR documentation Improvements or additions to documentation labels Oct 4, 2023
@kurbansitterley
Copy link
Contributor

kurbansitterley commented Sep 25, 2024

Documentation needed for:

  • battery
  • FPC (physical)
  • multi-effect crystallizer
  • deep well injection
  • solar still

Updates needed for:

  • Chemical softening

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Priority:Normal Normal Priority Issue or PR
Projects
None yet
Development

No branches or pull requests

2 participants