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

Update mhk equation docstrings #1217

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Update mhk equation docstrings #1217

wants to merge 3 commits into from

Conversation

mjprilliman
Copy link
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 self-assigned this Oct 8, 2024
@dguittet
Copy link
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

{"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
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
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mhk marine hydrokinetic
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update mhk equations for PySAM integration
2 participants