You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# xtide Docker image
2
2
3
-
Docker image for [XTide](https://flaterco.com/xtide/), a tide prediction program. Includes the `tide` CLI, `xttpd` web server, and `tcd-utils` (`build_tide_db`, `restore_tide_db`), compiled from source with harmonics data.
3
+
Docker image for [XTide](https://flaterco.com/xtide/), a tide prediction program. Includes the `tide` CLI, `xttpd` web server, `tcd-utils` (`build_tide_db`, `restore_tide_db`), and `congen` (tidal constituent generator), compiled from source with harmonics data.
4
4
5
5
## Usage
6
6
@@ -31,6 +31,14 @@ docker run --rm ghcr.io/openwatersio/xtide restore_tide_db -h
31
31
docker run --rm ghcr.io/openwatersio/xtide build_tide_db -h
32
32
```
33
33
34
+
### congen
35
+
36
+
Generate speeds, equilibrium arguments, and node factors for tidal constituents. The default input file is included at `/usr/local/share/congen_input.txt`.
37
+
38
+
```sh
39
+
docker run --rm ghcr.io/openwatersio/xtide congen < /usr/local/share/congen_input.txt
40
+
```
41
+
34
42
## Custom Harmonics File
35
43
36
44
The image includes the free harmonics dataset from [flaterco.com](https://flaterco.com/xtide/files.html). To use a custom `.tcd` harmonics file, mount it into the container and set the `HFILE_PATH` environment variable:
0 commit comments