Not included
What OTC and its SDKs leave out, and why. To request an item, select beside it. It opens an issue with the request form, so the request and its evidence are public.
Sources
- FES2022 model constants
The AVISO+ licence registration is pending. See FES2022.
- UHSLC Fast Delivery
The UHSLC service was unavailable when checked. GESLA records that come from UHSLC are in the release. See UHSLC Fast Delivery.
- Other sources that were checked
Their licence or access terms do not allow it. Examples are REDMAR (Spain), ISPRA (Italy), and UNAM and CICESE (Mexico). Considered, not added gives the reason for each.
To propose a source that is not listed, use the same form, with the licence, the access path and the coverage. CONTRIBUTING.md gives the details.
Releases
- Releases in an older format major
Each release is built in the current format only. A reader of an older major keeps the last release of that major, through
OTC_latest-f{MAJOR}.json(see Downloads).- XTide TCD file
A release has no XTide TCD file. It is planned as a one-way export, with other export formats, in a later release. See Converters.
SDKs
- Packages for conda, vcpkg, Conan and other package managers
The SDK channels are PyPI, RubyGems, npm and, for C, GitHub releases. One release workflow publishes to those four, with build provenance and SHA-256 checksums.
- SDKs in other languages, such as Rust
The SDKs are Python, Ruby, TypeScript and C, with one interface and one shared conformance suite. Other languages can call the C library.
- Constituents that a fit did not keep
The SDKs return the constituents that each set publishes. Inferring other constituents would change the published data without saying so.
Prediction in the SDKs
- Weak flood and weak ebb
Current events are maximum flood, maximum ebb and slack water. A weak flood or ebb (a current that strengthens toward flood or ebb but does not turn) is not reported, as in the reference engine.
- Heights between high and low water at some secondary stations
Where a secondary station's high-water and low-water offsets differ, only high and low water are given, as in NOAA's offset method. Where the two offsets are equal, the full curve is given.
- Current series at secondary current stations
Only current events are given there, from the reference station's events and the station's offsets. NOAA's offset method gives events only.
- Estimated current events
When a secondary station has no published offset for a current event type, events of that type are left out, and the result names the type. OTC does not publish estimated times.
- Local times in the C SDK without an OS time-zone database
Results are in UTC and carry the station's IANA time-zone name. The C SDK gives local times only where the operating system has a time-zone database.
- Years before 1700 or after 2100
The astronomical tables in a release cover 1700 to 2100. A time outside them is an error.
Outside what harmonic prediction can do
Harmonic constants describe the astronomical tide only, so these are not requests that OTC can take.
- Storm surge, wind set-up, river flow, seiches and ice. They do not repeat with astronomy, so they stay in the residual. See What it applies to in Tide Mechanics.
- Datums that the data does not give, such as a geoid, NAVD88, or LAT computed from constants. A prediction gives heights only above a datum that the constant set states.