Repository navigation
New features - #18
New features#18
Conversation
Add MHKiT Wave YAML Writer documentation detailing features, command structure, and usage examples.
Added documentation for the `--direction_file` option, including usage examples and details about the directional spectrum format.
alliemr123
left a comment
There was a problem hiding this comment.
added --direction_file for custom input wave directions
alliemr123
left a comment
There was a problem hiding this comment.
Added --save feature to save .pngs of figures
alliemr123
left a comment
There was a problem hiding this comment.
fix formatting with yaml.dump on body damping
alliemr123
left a comment
There was a problem hiding this comment.
updated directional writing/formatting for WITT model
|
Thanks Allie - this looks really useful. I've had a local run through the writer/reader and the overall approach looks good. Keeping each tool as one script plus a README is the right shape. There are a few things I think we should fix or clarify before merging:
A couple of things on the writer behaviour:
One smaller thing: rewriting the hydro YAML through PyYAML strips existing comments (the usual write, and the same pattern at line 662 and line 2374). It would be nice to preserve those if practical. Wrapping the work in a Nothing here looks fundamental, and I didn't hit any conflicts with current |
Added Python dependencies for demo feature tools including mhkit, h5py, numpy, and matplotlib.
alliemr123
left a comment
There was a problem hiding this comment.
I should've addressed all your immediate comments to the code and READMEs. I also made a note to add a demo tools section in the run_seastack README and a demos/feature in the packagelayout.md in docs once this gets merged.
and no_plot feature
Added functionality to compare multiple HDF5 files and overlay their data on the same plot. Introduced command-line arguments for comparison and labeling.
Added ruamel.yaml as a requirement for YAML handling.
to keep yaml comments and formatting
- check_package_contents.py: h5outputsReader.py is no longer a top-level demos file; check the five files under demos/features/ instead. - Add a Demo tools section to the demos README and a demos/features/ row to PACKAGE_LAYOUT.md. - h5_reader_README.md: relative mooring path, requirements note. - requirements.txt: fix reader filename, drop --trusted-host advice. - v1.1 release notes entry.
|
Thanks Allie, this is great. Everything from the review is sorted. I ran the writer against 46050 for regular and irregular cases, ran the outputs through I've merged this into As discussed, depth handling will be part of the wider SEA-Stack workflow improvements work rather than this PR. |
h5_reader.py: joint_torque plot title, --joints help (joints are named), clear error when no file is given. README: rotational DOFs and RSDAs are not plotted yet. requirements.txt: add PyYAML (MHKiT_writer imports yaml). tests/unit/python/test_demo_features.py: reader on a synthetic H5, analytic Hm0 and regular-height checks, YAML comment round trip, offline spectrum-file to run_seastack run (writer tests skip without MHKiT). CTest runs an unactivated conda Python, which cannot load numpy DLLs; prepend the interpreter's DLL folders for Python tests, as the comparison tests already do. Fixes test_external_pto_rm3_regression (0xc06d007f).
Adding four files: H5 output reader, corresponding readme description, MHKiT wave yaml writer, and corresponding description.