Skip to content

Update mhk equation docstrings#1217

Merged
mjprilliman merged 3 commits into
developfrom
me-eqn-update
Oct 30, 2024
Merged

Update mhk equation docstrings#1217
mjprilliman merged 3 commits into
developfrom
me-eqn-update

Conversation

@mjprilliman

Copy link
Copy Markdown
Collaborator

-Closes #1197
-See #1198 for discussion from patch

@mjprilliman mjprilliman added the mhk marine hydrokinetic label Oct 8, 2024
@mjprilliman mjprilliman added this to the SAM Fall 2024 Release milestone Oct 8, 2024
@mjprilliman mjprilliman requested a review from dguittet October 8, 2024 00:41
@mjprilliman mjprilliman self-assigned this Oct 8, 2024
@dguittet

Copy link
Copy Markdown
Collaborator

Are the inputs / outputs up to date for the docstrings, e.g. me_array_cable_length_doc?

I see 5 inputs in the doc but 10 in the function itself

Comment thread ssc/ssc_equations.h Outdated
{"me_array_cable_length", me_array_cable_length,
"Marine Energy", me_array_cable_length_doc,
{"me_array_cable_length", me_array_cable_length,
"MhkWave", me_array_cable_length_doc,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think this should be attached to the MhkCost module, since the outputs of these equations are inputs to MhkCost, not MhkWave or MhkTidal. Thoughts?

@mjprilliman mjprilliman changed the title Update mhk ssc_equation link for PySAM Update mhk equation docstrings Oct 22, 2024
@mjprilliman

Copy link
Copy Markdown
Collaborator Author

Updated equation docstrings. No longer linking mhk equations to PySAM modules at this time.

@mjprilliman mjprilliman requested a review from dguittet October 22, 2024 01:51

@dguittet dguittet left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks!

@mjprilliman mjprilliman merged commit 1750ef9 into develop Oct 30, 2024
@mjprilliman mjprilliman deleted the me-eqn-update branch October 30, 2024 15:53
@kbrunik kbrunik mentioned this pull request Feb 5, 2025
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update mhk equations for PySAM integration

3 participants