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

Add pointer to fluidized bed code in examples #126

Closed
andrewlee94 opened this issue Jul 8, 2024 · 2 comments
Closed

Add pointer to fluidized bed code in examples #126

andrewlee94 opened this issue Jul 8, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation Priority:Normal Normal Priority Issue or PR User support

Comments

@andrewlee94
Copy link
Member

A user recently asked where to find the code for the BFB models (IDAES/idaes-pse#1446). After checking the docs, it appears that it is not clear where to look for the actual code:

https://idaes-pse.readthedocs.io/en/stable/reference_guides/model_libraries/gas_solid_contactors/index.html

@andrewlee94 andrewlee94 added Priority:Normal Normal Priority Issue or PR documentation Improvements or additions to documentation User support labels Jul 8, 2024
@bpaul4
Copy link
Contributor

bpaul4 commented Jul 9, 2024

The page for the BFB unit model does include the class autodoc, which has the import location for the unit model: https://idaes-pse.readthedocs.io/en/stable/reference_guides/model_libraries/gas_solid_contactors/unit_models/bubbling_fluidized_bed.html#module-idaes.models_extra.gas_solid_contactors.unit_models.bubbling_fluidized_bed.

Checking some other pages, we do this for unit models, but not consistently for property packages or flowsheet models. It may be useful to ensure that all documented property and flowsheet models note the import path or have a link to the code.

@bpaul4
Copy link
Contributor

bpaul4 commented Jul 15, 2024

Addressed by IDAES/idaes-pse#1451.

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 User support
Projects
None yet
Development

No branches or pull requests

4 participants