search

NOAA-EMC / WW3-tools

20 stars 16 forks source link

Add unst_mesh_gen folder for unstructured mesh generation tools #53

Closed AliS-Noaa closed 7 months ago

AliS-Noaa commented 8 months ago

Pull Request Summary

Adding the unstructured mesh generation tool based on JIGSAWPY.

Description

Adding mesh generation script to create unstructured mesh (triangulation) for WW3 global modeling. This is under development by collaborating with the original JIGSAW developer. These scripts are capable of creating uniform unstructured meshes for global wave modeling.

Issue(s) addressed

fixes #52

Commit Message

This commit introduces a new mesh generation script capable of creating unstructured meshes for WW3 global modeling. The tool leverages JIGSAWPY for efficient triangulation. Main changes include: Implementation of the ocn_ww3.py to create uniform unstructured mesh for global WW3 model. Documentation updates in README.md to guide users on how to use the new tool This tool is under active development, with future work focused on variable unstructured mesh generation.

Check list

Testing

JessicaMeixner-NOAA commented 8 months ago

@AliS-Noaa thank you for making a PR with this. In the "issue(s) addressed" section above you can say that this fixes issue #52. The "Commit Message" section should be a commit message that can be used for a squash commit. Is there any additional planned work or are you ready for this PR to be reviewed?

AliS-Noaa commented 8 months ago

@JessicaMeixner-NOAA Thank you. I have updated the comment section.

JessicaMeixner-NOAA commented 8 months ago

@AliS-Noaa Did you intend to erase all the formatting of the PR template? If not here's the template so you can add it in above: 

# Pull Request Summary
<!-- A short overview of the PR --> 

## Description
<!--
Provide a detailed description of what this PR does.
What bug does it fix, or what feature does it add?

Please also include the following information: 
* Add any suggestions for a reviewer 
* Mention any labels that should be added:  _bug_, _documentation_, _enhancement_, _new feature_
-->

### Issue(s) addressed
<!--
* Please list any issues associated with this PR, including those the PR will fix/close. For example:  
- fixes #<issue_number>
- fixes noaa-emc/ww3-tools/issues/<issue_number>
-->

### Commit Message
<!--
Please provide a short summary of this PR, which will be used during _Squash and Merge_ and will be shown as a git log message.  Be sure to add any co-authors here. 
-->

### Check list  

<!-- After creating the PR you can check each of the items below that have been completed -->

- [ ] Branch is up to date with the authoritative repository (NOAA-EMC) develop branch. 

### Testing

* How were these changes tested?
AliS-Noaa commented 8 months ago

@JessicaMeixner-NOAA I automated the black sea inclusion/exclusion and also, I added a README.md. Please let me know your opinion/suggestions.

AliS-Noaa commented 8 months ago

@JessicaMeixner-NOAA I revised the README.md accordingly.

JessicaMeixner-NOAA commented 7 months ago

@AliS-Noaa I see that this is still a draft, is it ready to be reviewed or do you have other planned changes?