Skip to content

Commit

Permalink
prep for v3.3 (#163)
Browse files Browse the repository at this point in the history
* Update changelog and add citing section. 

Co-authored-by: William Pringle <[email protected]>
  • Loading branch information
Keith Roberts and WPringle authored Dec 22, 2020
1 parent fa47a5c commit 63c7119
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ All pull requests are tested with Jenkins on a local host. However, to ensure th
References!
==============

If you make use of `OceanMesh2D` please include a reference to [1], and to any of [2]-[5] if pertinent:
If you make use of `OceanMesh2D` please include a reference to [1], and to any of [2]-[5] if pertinent ([latex .bib file](https://github.com/CHLNDDEV/OceanMesh2D/tree/Projection/UserGuide/OceanMesh2D_library.bib)). We would also appreciate using our [logo](https://github.com/CHLNDDEV/OceanMesh2D/tree/Projection/imgs) in a presentation featuring `OceanMesh2D`.
```
[1] - Roberts, K. J., Pringle, W. J., and Westerink, J. J., 2019.
Expand All @@ -108,6 +108,11 @@ If you make use of `OceanMesh2D` please include a reference to [1], and to any o
Geoscientific Model Development Discussions. https://doi.org/10.5194/gmd-2020-123.
```
In addition, best practice when using software in a scientific publication is to cite the permanent doi corresponding to the version used (e.g., for reproducibility). All our releases are archived at the following `Zenodo` repository doi [link](https://doi.org/10.5281/zenodo.1341384).
```
Authors (202X). CHLNDDEV/OceanMesh2D: OceanMesh2D VX.X. Zenodo. https://doi.org/10.5281/zenodo.1341384
```
Please fill in the version (VX.X), author list and year corresponding to the version used.

## `DISCLAIMER: `
The boundary of the meshing domain must be a polygon (first point equals the last and non-self intersecting) but it does not need to be simplified. Read the user guide for more information about the inputs.
Expand All @@ -128,16 +133,17 @@ Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## Unreleased
### Unreleased

### Fixed
### [3.3.0] - 2020-12-21
## Fixed
- Users without mapping toolbox could not read in shapefiles because of a bug that
made them required to have a 3d shapefiles.
- plotting `gdat` with no shoreline.
- plotting a mesh's bathymetry with a non-zero datum using cmocean.
- cell-averaging interpolation method in msh.interp fixed for unequal lon-lat DEM grid spacings

### Added
## Added
- Mesh patch smoother
- Ability to remesh abritary patches of elements within the domain while respecting user-defined mesh sizes and the patches boundaries.
- Ability to use the TPXO9 Atlas for the tidal bcs and sponge (inside tidal_data_to_ob.m and Calc_Sponge.m) by using '**' wildcards in place of the constituent name within the tidal atlas filename (the atlas has an individual file for each constituent).
Expand All @@ -146,7 +152,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- "mapMeshProperties" msh method ports over mesh properties for a mesh subset
- 'invert' option in the msh.interp method to turn off the DEM value inversion typically performed

### Changed
## Changed
- for the make_bc msh method 'auto'/'auto_outer' options, allowing for the 'depth' method of classification to use the interpolated depths on the mesh if gdat is empty.
- improving help for make_bc msh method, Make_f15.m and Calc_Sponge.m
- renamed "ExtractSubDomain.m" to "extract_subdomain.m"
Expand Down
54 changes: 54 additions & 0 deletions UserGuide/OceanMesh2D_library.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
@article{Pringle2020,
author = {Pringle, William J. and Wirasaet, Damrongsak and Roberts, Keith J. and Westerink, J.},
doi = {10.5194/gmd-2020-123},
journal = {Geoscientific Model Development Discussions},
pages = {in review},
title = {{Global Storm Tide Modeling with ADCIRC v55: Unstructured Mesh Design and Performance}},
year = {2020}
}
@phdthesis{Roberts2019b,
author = {Roberts, Keith J.},
pages = {229},
school = {University of Notre Dame},
title = {{Unstructured Mesh Generation and Dynamic Load Balancing for Coastal Ocean Hydrodynamic Simulation}},
url = {https://curate.nd.edu/show/4q77fr0022c},
year = {2019}
}
@misc{OM_latest_version,
author = {Roberts, Keith J. and Pringle, William J.},
doi = {10.5281/zenodo.1341384},
publisher = {Zenodo},
title = {{CHLNDDEV/OceanMesh2D: OceanMesh2D VX.X}},
year = {2020}
}
@article{Roberts2019,
author = {Roberts, Keith J. and Pringle, William J. and Westerink, Joannes J.},
doi = {10.5194/gmd-12-1847-2019},
journal = {Geoscientific Model Development},
pages = {1847--1868},
title = {{OceanMesh2D 1.0: MATLAB-based software for two-dimensional unstructured mesh generation in coastal ocean modeling}},
volume = {12},
year = {2019}
}
@article{Roberts2019a,
archivePrefix = {arXiv},
arxivId = {10.31223/osf.io/nwde7},
author = {Roberts, Keith J. and Pringle, William J. and Westerink, Joannes J. and Contreras, Maria Teresa and Wirasaet, Damrongsak},
doi = {10.1016/j.ocemod.2019.101509},
eprint = {osf.io/nwde7},
journal = {Ocean Modelling},
pages = {101509},
primaryClass = {10.31223},
title = {{On the automatic and a priori design of unstructured mesh resolution for coastal ocean circulation models}},
volume = {144},
year = {2019}
}
@techreport{Roberts2018a,
author = {Roberts, Keith J. and Pringle, William James},
doi = {10.13140/RG.2.2.21840.61446/1},
institution = {University of Notre Dame},
number = {June},
pages = {39},
title = {{OceanMesh2D: User guide - Precise distance-based two-dimensional automated mesh generation}},
year = {2018}
}

0 comments on commit 63c7119

Please sign in to comment.