MHKiT-Software / MHKiT-Python

MHKiT-Python provides the marine renewable energy (MRE) community tools for data processing, visualization, quality control, resource assessment, and device performance.

https://mhkit-software.github.io/MHKiT/

BSD 3-Clause "New" or "Revised" License

47 stars 45 forks source link

Mooring module #235

Closed hivanov-nrel closed 11 months ago

hivanov-nrel commented 1 year ago

Mooring module

create functions for mooring module:

[x] read MoorDyn OUT file
[x] read MoorDyn input file
[x] calculate lay length
[x] create 3d animation
[x] create 2d animation

Tests created for

[x] io
[x] general
[x] graphics

hivanov-nrel commented 1 year ago

@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 commented 1 year ago

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

hivanov-nrel commented 1 year ago

@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 commented 1 year ago

@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!

hivanov-nrel commented 1 year ago

@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 commented 1 year ago

@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 commented 1 year ago

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

https://github.com/hivanov-nrel/MHKiT-Python/pull/6

hivanov-nrel commented 12 months ago

@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