Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

> A public database of tide harmonics

This database includes harmonic constituents for tide prediction from various sources around the world. These constants can be used with a tide harmonic calculator like [Neaps](https://github.com/neaps/neaps) to create astronomical tide predictions.
This database includes harmonic constituents for tide prediction from various sources around the world. These constants can be used with a tide harmonic calculator like [Neaps](https://github.com/openwatersio/neaps) to create astronomical tide predictions.

## Sources

- ✅ [**NOAA**](data/noaa/README.md): National Oceanic and Atmospheric Administration
~3400 stations, mostly in the United States and its territories. Updated monthly via [NOAA's API](https://api.tidesandcurrents.noaa.gov/mdapi/prod/).

- ✅ [**TICON-4**](data/ticon/README.md): TIdal CONstants based on GESLA-4 sea-level records
~4200+ global stations - ([#16](https://github.com/neaps/tide-database/pull/16))
~4200+ global stations - ([#16](https://github.com/openwatersio/tide-database/pull/16))

If you know of other public sources of harmonic constituents, please [open an issue](https://github.com/neaps/tide-database/issues/new) to discuss adding them.
If you know of other public sources of harmonic constituents, please [open an issue](https://github.com/openwatersio/tide-database/issues/new) to discuss adding them.

## Usage

The database is currently only available as an NPM package, but may be available in other formats like [sqlite](https://github.com/neaps/tide-database/issues/18) and [xtide's tcd format](https://github.com/neaps/tide-database/issues/19) in the future.
The database is currently only available as an NPM package, but may be available in other formats like [sqlite](https://github.com/openwatersio/tide-database/issues/18) and [xtide's tcd format](https://github.com/openwatersio/tide-database/issues/19) in the future.

### JavaScript / TypeScript

Expand Down Expand Up @@ -153,7 +153,7 @@ Releases of this database use [Semantic Versioning](https://semver.org/), with t

## Releasing

Releases are created by [running the Publish action](https://github.com/neaps/tide-database/actions/workflows/publish.yml) on GitHub Actions. This action will use the major and minor `version` defined in `package.json`, and set the patch version to the current date.
Releases are created by [running the Publish action](https://github.com/openwatersio/tide-database/actions/workflows/publish.yml) on GitHub Actions. This action will use the major and minor `version` defined in `package.json`, and set the patch version to the current date.

## License

Expand All @@ -163,4 +163,4 @@ Releases are created by [running the Publish action](https://github.com/neaps/ti

If using this project, please attribute it as:

> Tide harmonic constituents from the Neaps tide database (https://github.com/neaps/tide-database)
> Tide harmonic constituents from the Neaps tide database (https://github.com/openwatersio/tide-database)
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
"harmonics",
"database"
],
"homepage": "https://github.com/neaps/tide-database#readme",
"homepage": "https://openwaters.io/tides/database",
"bugs": {
"url": "https://github.com/neaps/tide-database/issues"
"url": "https://github.com/openwatersio/tide-database/issues"
},
"repository": {
"type": "git",
"url": "git+https://github.com/neaps/tide-database.git"
"url": "git+https://github.com/openwatersio/tide-database.git"
},
"license": "MIT",
"author": "Brandon Keepers <brandon@openwaters.io>",
Expand Down