Add Wind+PEM tracking and stochastic bidding documentation

[Xinhe-Chen]

trafficstars

Fixes

Summary/Motivation:

Add documentation for wind+pem renewable IES tracking and stochastic bidding.

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.

[codecov[bot]]

Codecov Report

Base: 70.32% // Head: 70.26% // Decreases project coverage by -0.06% :warning:

Coverage data is based on head (3074b65) compared to base (b30c054). Patch has no changes to coverable lines.

:exclamation: Current head 3074b65 differs from pull request most recent head 8367219. Consider uploading reports for the commit 8367219 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1090      +/-   ##
==========================================
- Coverage   70.32%   70.26%   -0.06%     
==========================================
  Files         405      405              
  Lines       66342    66266      -76     
  Branches    12342    12320      -22     
==========================================
- Hits        46653    46564      -89     
- Misses      17319    17328       +9     
- Partials     2370     2374       +4     

Impacted Files	Coverage Δ
idaes/core/util/model_diagnostics.py	39.32% <0.00%> (-9.90%)	:arrow_down:
idaes/ver.py	61.53% <0.00%> (-4.62%)	:arrow_down:
idaes/core/base/control_volume1d.py	89.18% <0.00%> (-0.98%)	:arrow_down:
idaes/core/base/control_volume_base.py	90.54% <0.00%> (-0.98%)	:arrow_down:
...xtra/power_generation/properties/flue_gas_ideal.py	77.50% <0.00%> (-0.49%)	:arrow_down:
idaes/core/base/property_set.py	96.98% <0.00%> (-0.16%)	:arrow_down:
idaes/core/base/property_meta.py	94.44% <0.00%> (ø)
idaes/core/base/control_volume0d.py	89.40% <0.00%> (+0.05%)	:arrow_up:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

[Xinhe-Chen]

@adowling2 @dguittet This is ready to review.

[adowling2]

I'll review this later tonight.

[adowling2]

@radhakrishnatg could be another good reviewer

[andrewlee94]

@adowling2 Note however that we hope to cut a release candidate today (pending a Pyomo release), so you might need to work with @ksbeattie and @lbianchi-lbl if this needs to be part of the February release.

[dguittet]

adding @bknueven also for his input

[dguittet]

I'm confused as to why this is being merged into the documentation at this point in time. Where is the actual code? There is already an existing Bidder.py in IDAES but it isn't specific for Wind + PEM. Is the Wind + PEM feature going to be a modification of the existing Bidder.py, or is there supposed to be another piece of code in addition? Is there going to be in IDAES many different Bidders for different technology use cases?

[Xinhe-Chen]

I'm confused as to why this is being merged into the documentation at this point in time. Where is the actual code? There is already an existing Bidder.py in IDAES but it isn't specific for Wind + PEM. Is the Wind + PEM feature going to be a modification of the existing Bidder.py, or is there supposed to be another piece of code in addition? Is there going to be in IDAES many different Bidders for different technology use cases?

@dguittet I think this is what we are going to implement next stage and we will have the docs in advance.

[bknueven]

I am also a bit confused. It would seem like this documentation should also exist in dispatches. If IDAES were to document an example shouldn't it start with the one already included? https://github.com/IDAES/idaes-pse/tree/main/idaes/apps/grid_integration/examples.

[andrewlee94]

@Xinhe-Chen I also find it strange that you are adding documentation for something that does not exist yet. It is fine to work on it ahead of time, but it generally shouldn't be added to the actual docs until the code that goes with it is ready. Otherwise, users reading the docs will expect these features to be there, and then be confused when they are not.

[Xinhe-Chen]

I am also a bit confused. It would seem like this documentation should also exist in dispatches. If IDAES were to document an example shouldn't it start with the one already included? https://github.com/IDAES/idaes-pse/tree/main/idaes/apps/grid_integration/examples.

I think we need this PR for a milestone regarding hydrogen co-production.

[Xinhe-Chen]

Decision on Feb 16: Merge this PR after the codes are merged.

[ksbeattie]

I've converted this to a draft PR since it appears that this won't be part of the Feb (2.0) release. Please let me know if that's not going to be the case.

[ksbeattie]

Update (Apr 17th): This is waiting on code that is in @dguittet branch. This is not required for the June release of DISPATCHES but will be included afterwards.

[ksbeattie]

@Xinhe-Chen, @dguittet, @adowling2 is this still going to be done (in idaes)?

[adowling2]

Yes.

[ksbeattie]

Yes.

I've added this to the Nov release board and updated the branch since it's been quite a while. Let me know if Nov is not a practical timeline for this.

[ksbeattie]

@adowling2, the Nov release is coming up. Is this going to happen in the next few weeks?

[adowling2]

No, push to Feb.

[ksbeattie]

@Xinhe-Chen & @adowling2 can this be updated, reviewed and merge for this Feb 2024 release?

[Xinhe-Chen]

@ksbeattie @adowling2 Sorry for the late reply. The wind + PEM bidder has been done in dispatches. I will clean up the codes and add tests to merge them into IDAES. I don't think I can do this in the Feb release, I would like to postpone this PR to the March release. Many thanks.

[ksbeattie]

@ksbeattie @adowling2 Sorry for the late reply. The wind + PEM bidder has been done in dispatches. I will clean up the codes and add tests to merge them into IDAES. I don't think I can do this in the Feb release, I would like to postpone this PR to the March release. Many thanks.

I've taken this off the Feb release board. When we create the next release board, please come to the dev call to have this added back to that board.

[ksbeattie]

@adowling2 , @Xinhe-Chen: Might this now be a candidate for a May release?

[Xinhe-Chen]

@adowling2 , @Xinhe-Chen: Might this now be a candidate for a May release?

Yes. I am still working on this PR and it will be good to put it on May release.

[Xinhe-Chen]

The documentation is moved to https://github.com/IDAES/idaes-pse/pull/1407

[andrewlee94]

@Xinhe-Chen Seeing as the documentation has been moved, can we close this PR?

[Xinhe-Chen]

@Xinhe-Chen Seeing as the documentation has been moved, can we close this PR?

Yes I think we can close this PR.