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

Flowsheets documentation ADM1, ASM1, ASM2d #1376

Merged
merged 15 commits into from
May 8, 2024

Conversation

agarciadiego
Copy link
Contributor

Fixes/Resolves:

#1219

Summary/Motivation:

  • Adds documentation for ASM1
  • Adds documentation for ASM2d
  • Adds documentation for ADM1

Changes proposed in this PR:

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@agarciadiego agarciadiego self-assigned this May 3, 2024
@agarciadiego agarciadiego added documentation Improvements or additions to documentation 1.0 Hard requirement for the 1.0 release labels May 3, 2024
Copy link
Contributor

@MarcusHolly MarcusHolly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general things look good, just a few minor things to address.

docs/technical_reference/flowsheets/ADM1.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/ASM1.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/ASM1.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/ASM2d.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/ASM2d.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/ASM2d.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/ASM2d.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/ADM1.rst Show resolved Hide resolved
docs/technical_reference/flowsheets/ADM1.rst Outdated Show resolved Hide resolved
agarciadiego and others added 9 commits May 3, 2024 16:17
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Copy link

codecov bot commented May 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.84%. Comparing base (e29daf5) to head (95f0865).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1376      +/-   ##
==========================================
- Coverage   93.93%   93.84%   -0.09%     
==========================================
  Files         340      339       -1     
  Lines       36031    35887     -144     
==========================================
- Hits        33846    33679     -167     
- Misses       2185     2208      +23     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@MarcusHolly MarcusHolly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - a few more minor typos to correct

docs/technical_reference/flowsheets/ADM1.rst Outdated Show resolved Hide resolved
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Copy link
Contributor

@luohezhiming luohezhiming left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lbianchi-lbl lbianchi-lbl enabled auto-merge (squash) May 7, 2024 23:59
@lbianchi-lbl lbianchi-lbl merged commit 38735ec into watertap-org:main May 8, 2024
24 checks passed
@lbianchi-lbl lbianchi-lbl added the Priority:Normal Normal Priority Issue or PR label May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0 Hard requirement for the 1.0 release documentation Improvements or additions to documentation Priority:Normal Normal Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants