Initial REE Costing Framework

[bpaul4]

Fixes

Summary/Motivation:

Initial framework for REE costing as part of PrOMMiS cost estimation efforts.

Changes proposed in this PR:

• Adds first group of cost accounts for REE plants and support to load/execute them in the IDAES Costing Framework
• Required modifications to IDAES Power Plant Costing Framework, including new methods for REE account handling and an expansion of the report call
• Example flowsheet and test file with the first two accounts, which will be expanded to include all accounts later
• Some updates to the power plant methods and documentation, notably for a new option to support multiple trains of a unit operation
• REE costing documentation and bound estimation methods coming soon

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]

Codecov Report

Patch coverage: 69.97% and project coverage change: -0.06% ⚠️

Comparison is base (38b8333) 76.84% compared to head (c3b8ad5) 76.78%.
Report is 8 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1238      +/-   ##
==========================================
- Coverage   76.84%   76.78%   -0.06%     
==========================================
  Files         390      391       +1     
  Lines       61867    62321     +454     
  Branches    11388    11473      +85     
==========================================
+ Hits        47539    47855     +316     
- Misses      11866    11959      +93     
- Partials     2462     2507      +45     

Files Changed	Coverage Δ
...ra/power_generation/costing/power_plant_capcost.py	69.08% <67.02%> (-1.86%)	⬇️
...a/power_generation/costing/costing_dictionaries.py	100.00% <100.00%> (ø)
...extra/rare_earth_recovery/ree_initial_flowsheet.py	100.00% <100.00%> (ø)

... and 10 files with indirect coverage changes

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

[andrewlee94]

Is this the right place for this? It seems really odd that something to do with REEs is ending up in the power plant sub-folder. This might indicate that the power_generation/costing folder really needs to be moved out to a models_extra/costing as it has spread beyond just power generation.

[bpaul4]

@andrewlee94 I am open to a discussion on reorganizing the costing code, this is just an initial implementation and the team decided to leverage our existing framework as a "path of least resistance" in the first pass. The costing folder probably does need to move to support more generic types and we could rename some files (e.g. power_plant_capcost.py >>> plant_capcost.py) to reflect our new capabilities.

[andrewlee94]

I think it really should be moved before this is merged - otherwise it is likely to linger. Seeing as this is our public repo, we should make an effort to ensure that it is user friendly.

[andrewlee94]

Again, is this the right place for this? For one, it is rather isolated at the moment, and it appears to be more of a minimal test case for costing than an actual flowsheet (thus the name would probably be misleading to users). Would this be better placed in the PrOMMiS workspace, which is where the first process flowsheet will go as well (at least until we have something more comprehensive to show to the world)?

[bpaul4]

If the PrOMMiS workspace is ready, I can push the script there once it is complete and remove it from this PR.

[andrewlee94]

https://github.com/prommis/workspace

[bpaul4]

Closing this in favor of https://github.com/prommis/workspace/pull/13