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

Mooring module #235

Merged
merged 21 commits into from
Jul 14, 2023
Merged

Mooring module #235

merged 21 commits into from
Jul 14, 2023

Conversation

hivanov-nrel
Copy link
Contributor

@hivanov-nrel hivanov-nrel commented Apr 13, 2023

Mooring module

create functions for mooring module:

  • read MoorDyn OUT file
  • read MoorDyn input file
  • calculate lay length
  • create 3d animation
  • create 2d animation

Tests created for

  • io
  • general
  • graphics

@hivanov-nrel hivanov-nrel marked this pull request as draft April 13, 2023 21:16
@hivanov-nrel hivanov-nrel added the enhancement New feature or request label Apr 13, 2023
@hivanov-nrel
Copy link
Contributor Author

@ssolson @rpauly18 I think a first pass at the mooring IO module is complete at this point. It's one function but it can ingest both the input and output files from Moordyn. There is still room for refinement and added functionality, but I need to find more complicated example output files than what's currently available to me.

I'm working on a couple of simple functions that then utilize the output data to do some calculations and plotting. At this point, my question is, should we try to squeeze these extra functions into this PR or should we separate them into a later PR? What are your thoughts?

@rpauly18
Copy link
Contributor

rpauly18 commented Jun 6, 2023

@hivanov-nrel keep working off of this PR so we can have a complete example to work from on the review.

@hivanov-nrel hivanov-nrel changed the title Mooring IO Mooring module Jun 13, 2023
@hivanov-nrel hivanov-nrel marked this pull request as ready for review June 13, 2023 21:51
@hivanov-nrel
Copy link
Contributor Author

@ssolson @rpauly18 okay I think this is ready for review. Not sure who wants to take point on that.

I definitely know of some future functionality we could add, but in the interest of time, I thought this would be okay to start. Please let me know if you disagree.

@rpauly18
Copy link
Contributor

@hivanov-nrel I agree that this looks like a good start. We will figure out who has time to tackle this review and make a formal assignment. Thanks!

@ssolson ssolson self-requested a review June 16, 2023 15:24
Copy link
Contributor

@ssolson ssolson left a comment

Choose a reason for hiding this comment

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

@hivanov-nrel thanks for getting this started. I have made some general comments on this first function. Could you propagate these suggestions through the PR?

mhkit/mooring/general.py Outdated Show resolved Hide resolved
mhkit/mooring/general.py Outdated Show resolved Hide resolved
mhkit/mooring/general.py Outdated Show resolved Hide resolved
mhkit/mooring/general.py Outdated Show resolved Hide resolved
@hivanov-nrel
Copy link
Contributor Author

@ssolson Sorry for the holdup; i just pushed a commit that addresses your comments. Please let me know if there is anything else we need. Have you gone through the example notebook?

@ssolson
Copy link
Contributor

ssolson commented Jun 30, 2023

@ssolson Sorry for the holdup; i just pushed a commit that addresses your comments. Please let me know if there is anything else we need. Have you gone through the example notebook?

Thanks @hivanov-nrel . My last comments were simply a quick check to knock out some easy fixes. I am going to take a deeper look today. I will go run the example notebook now.

@ssolson
Copy link
Contributor

ssolson commented Jul 6, 2023

@hivanov-nrel some suggested updates are in a PR on your fork

hivanov-nrel#6

Mooring Example Notebook and Latested Development Branch
@hivanov-nrel
Copy link
Contributor Author

@ssolson thanks for your suggestions. I've approved the PR and merged into my fork. Let me know if there any other changes we need to make to this PR before merging to the dev branch

Copy link
Contributor

@ssolson ssolson left a comment

Choose a reason for hiding this comment

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

Chris checkout my PR hivanov-nrel#7 for my needed changes.

I just have 1 question below and the issue opened and I we are good to go on this PR.

mhkit/mooring/general.py Outdated Show resolved Hide resolved
mhkit/mooring/__init__.py Outdated Show resolved Hide resolved
mhkit/mooring/io.py Outdated Show resolved Hide resolved
Proposed Module Changes
Copy link
Contributor

@ssolson ssolson left a comment

Choose a reason for hiding this comment

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

Approved for merge into development.

The PR failed 1 of 2 hindcast tests but that is unrelated to this PR.

@ssolson ssolson merged commit 008cba8 into MHKiT-Software:develop Jul 14, 2023
17 of 18 checks passed
@ssolson ssolson mentioned this pull request Aug 11, 2023
ssolson added a commit that referenced this pull request Aug 11, 2023
**MHKiT 0.7.0 Release Notes**

This release introduces exciting new features and improvements to the MHKiT package:

- **Mooring Module**: We are pleased to introduce the new mooring module. This addition primarily supports outputs from MoorDyn. Within this module, users can:
  - Import data
  - Calculate lay length
  - Visualize mooring line movements in 2D and 3D with graphical animations.
  
  Accompanying this module is an example notebook to guide users on its functionalities.

- **Dolfyn Module Revamp**: The Dolfyn module has been overhauled. Enhancements include:
  - Turbulence calculation capability
  - Performance measures for tidal power as outlined in IEC/TS 6200-200.

- **New Contributions**: A big shoutout to our community member, @mbruggs, for adding the ability to compute surface elevation using IFFT.

- **NDBC Buoy Metadata**: Users can now fetch NDBC buoy metadata directly through MHKiT.

- **Delft3D Module Update**: Stay up to date with support for the latest Delft3D NetCDF format.

**Additions**
- #235
- #232 
- #236 
- #250
- #239
- #248

**Bug Fixes**
- #226 
- #238

**Meta/Minor Changes**
- #220
- #243
- #225 
- #231
- #224

Thank you to all of the contributers who helpped with this release:
@mbruggs @Graham-EGI @castillocesar @jmcvey3 @hivanov-nrel  @browniea @cmichelenstrofer @akeeste  @maxwelllevin @rpauly18 @ssolson
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants