Skip to content

Developer manual #728

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.

Sign up for GitHub

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

Jump to bottom
Merged
kmruehl merged 23 commits into from
Oct 12, 2021
Merged

Developer manual #728

kmruehl merged 23 commits into from
Oct 12, 2021

Conversation

@akeeste
Copy link
Contributor

@akeeste akeeste commented Oct 6, 2021 •
edited by kmruehl
Loading

This PR updates the developer manual to contain information on the method, reasoning, etc of certain features. Right now the developer manual seems best used to explain the reasoning (how, why) behind WEC-Sim features with an especially complex set-up, as opposed to explaining the what a feature does, which could be in the user manual. This creates a written reference for future team members or external developers.

Current content includes discussion on:

  • Added mass treatment
  • Library updates
  • Run from Simulink
  • Simulink model and mask functions @akeeste
  • Sub library set-up

Future developer manual content could include:

  • WEC-Sim formatting/style guide (removed pending further discussion)
  • Passive Yaw
  • Morison element
  • others...

@akeeste akeeste added Documentation related to docs Feature new feature request labels Oct 6, 2021
@akeeste akeeste marked this pull request as ready for review October 6, 2021 17:24
@kmruehl
Copy link
Collaborator

kmruehl commented Oct 6, 2021

@akeeste did you mean to include updates to the SimulinkMaskFunctions and the WEC-Sim Library in this PR?

@akeeste
Copy link
Contributor Author

akeeste commented Oct 6, 2021

@kmruehl Yes I did do some clean up in the library masks and the run from simulink callbacks. I did not anticipate merging this in before v4.4 which is why I hadn't worried about them conflicting. On Friday I can work to update this PR with the current dev branch.

@kmruehl
Copy link
Collaborator

kmruehl commented Oct 7, 2021

@akeeste got it, thanks for the clarification. I think the easiest thing to do would be to split this PR into two PRs:

  • developer documentation --> for v4.4
  • updates to the clean up in the library masks and the run from simulink callbacks --> for v4.4 if there's time, if not for v5.5

If I have some time tomorrow I can work on creating a PR the developer documentation, if not I'll leave it to you on Friday. Thanks!

@akeeste
Copy link
Contributor Author

akeeste commented Oct 8, 2021

@kmruehl I have reset this PR to only update developer documentation. I will move the over clean up to another PR

@akeeste akeeste mentioned this pull request Oct 8, 2021
Merged
@kmruehl
Copy link
Collaborator

kmruehl commented Oct 9, 2021

@akeeste thank you!

@kmruehl kmruehl self-requested a review October 9, 2021 00:21
kmruehl
kmruehl approved these changes Oct 12, 2021
View reviewed changes
Copy link
Collaborator

@kmruehl kmruehl left a comment

Choose a reason for hiding this comment

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

@akeeste thank you so much! This is a huge help, especially for managing the Library for Run from Simulink.

@kmruehl kmruehl merged commit ee02bb5 into WEC-Sim:dev Oct 12, 2021
@akeeste akeeste deleted the developer_manual branch October 20, 2021 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kmruehl kmruehl kmruehl approved these changes

Assignees

No one assigned

Labels

Documentation related to docs Feature new feature request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@akeeste @kmruehl