search

BioSTEAMDevelopmentGroup / biosteam

The Biorefinery Simulation and Techno-Economic Analysis Modules; Life Cycle Assessment; Chemical Process Simulation Under Uncertainty
Other
179 stars 35 forks source link

Biorefineries docs #145

Closed yoelcortes closed 1 year ago

yoelcortes commented 1 year ago

@yalinli2,

This pull request adds modules in the Biorefineries library to the BioSTEAM documentation. The only change to the code is to set the __name__, __doc__, and __signature__ attributes of SystemFactory objects for Sphinx to document SystemFactory objects more easily. For example, this is how the wastewater treatment system factory looks in the documentation:

image

I won't be adding doctests and examples to the biorefinery systems until February due to some deadlines in January, but I think this is a good start.

Once docs (this branch) and the thermosteam rxn branches are merged, I'll upload the latest versions to PyPI.

Thanks!

yoelcortes commented 1 year ago

@yalinli2, looks like the CI failed due to the new version listed on setup.py, but all tests are passing locally. Next time I'll update setup.py after getting the pull request approved.

Thanks!