Roms-tools

What's Changed

This release supports more accurate topography regridded from SRTM15, but also still supports the previous ETOPO5 topography (sufficient for configurations with horizontal resolution > O(5km)). Moreover, the land mask is improved since it is now inferred from a separate coastline dataset rather than from the regridded topography.

Please note that the topography format is no longer backward compatible. The syntax for specifying the topography source has changed. The new format is:

grid = Grid(topography_source={"name": "ETOPO5"})

Instead of the previous format:


grid = Grid(topography_source="ETOPO5")


PRs:
* Regrid from SRTM15 topography by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/172


**Full Changelog**: https://github.com/CWorthy-ocean/roms-tools/compare/v1.7.0...v2.0.0

What's Changed

The creation of physical river forcing (river volume flux, river temperature, river salinity) is now supported.

* Page on required datasets in documentation by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/192
* River forcing by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/194
* River forcing addendum by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/195
* Correct time in river forcing by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/196
* Correct `river_tracer` dimension by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/197


**Full Changelog**: https://github.com/CWorthy-ocean/roms-tools/compare/v1.6.2...v1.7.0

What's Changed
* 1D fill validation for boundary forcing by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/191


**Full Changelog**: https://github.com/CWorthy-ocean/roms-tools/compare/v1.6.1...v1.6.2

What's Changed
* Test with python 3.13 by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/187
* Don't separate temporally into multiple files by default by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/190


**Full Changelog**: https://github.com/CWorthy-ocean/roms-tools/compare/v1.6.0...v1.6.1

What's Changed

The user has now the option between a 1D and 2D horizontal fill when generating the boundary forcing. Previously only the 2D fill was available. The new 1D fill is faster and the new default. The documentation explains in what cases the 2D fill is recommended.

* Boundary forcing can use 1D or 2D horizontal fill by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/184
* Conda install instructions by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/183


**Full Changelog**: https://github.com/CWorthy-ocean/roms-tools/compare/v1.5.0...v1.6.0

What's Changed: Performance

We have achieved a huge performance boost by correcting the fill method for velocities fields (180). Minor performance improvements were achieved by less wasteful interpolation for the boundary forcing generation (175).

* Correct fill method for velocity fields by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/180
* Vertical interpolation by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/174
* Interpolate onto four boundaries separately by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/175
* Masking when plotting ICs by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/176
* Enable line plots for 2D ICs by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/177
* Make IC generation consistent with boundary forcing generation by NoraLoose in https://github.com/CWorthy-ocean/roms-tools/pull/178


**Full Changelog**: https://github.com/CWorthy-ocean/roms-tools/compare/v1.4.2...v1.5.0