Updating documentation

waterinstitute · Oct 18, 2024 · 9250db4 · 9250db4
1 parent 912134e
commit 9250db4
Showing 1 changed file with 65 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -165,6 +165,71 @@ $ metget track --year 2022 --storm 9 --basin al --type forecast --advisory 3 #..
 $ metget track --year 2022 --storm 9 --basin al --type besttrack #...Hurricane Ian 2022, best track data
 ```
 
+#### Example 7: Request the storm track data from the A-Deck
+This example demonstrates how to get the storm track data for the GFS model (i.e. AVNO) for a specific storm
+and cycle. The data is returned in tabular format, but optionally can be requested in a machine-readable json
+format.
+```bash
+$ metget adeck --storm 14 --model AVNO --cycle 2024-10-08
++---------------------+-----------+----------+---------------+------------------+
+|         Time        | Longitude | Latitude | Pressure (mb) | Wind Speed (mph) |
++---------------------+-----------+----------+---------------+------------------+
+| 2024-10-08T00:00:00 |   -90.5   |   21.8   |      978      |      71.35       |
+| 2024-10-08T06:00:00 |   -89.7   |   21.8   |      973      |      88.61       |
+| 2024-10-08T12:00:00 |   -88.7   |   22.2   |      965      |      85.16       |
+| 2024-10-08T18:00:00 |   -88.0   |   22.5   |      960      |      88.61       |
+| 2024-10-09T00:00:00 |   -87.1   |   22.9   |      964      |      86.31       |
+| 2024-10-09T06:00:00 |   -86.3   |   23.6   |      962      |      88.61       |
+| 2024-10-09T12:00:00 |   -85.6   |   24.5   |      959      |      86.31       |
+| 2024-10-09T18:00:00 |   -84.8   |   25.5   |      957      |      89.76       |
+| 2024-10-10T00:00:00 |   -83.7   |   26.6   |      955      |      94.36       |
+| 2024-10-10T06:00:00 |   -82.8   |   27.5   |      956      |      96.67       |
+| 2024-10-10T12:00:00 |   -81.5   |   28.4   |      972      |      59.84       |
+| 2024-10-10T18:00:00 |   -80.2   |   28.9   |      982      |      59.84       |
+| 2024-10-11T00:00:00 |   -78.6   |   29.3   |      986      |       67.9       |
+| 2024-10-11T06:00:00 |   -77.4   |   29.4   |      991      |       67.9       |
+| 2024-10-11T12:00:00 |   -76.2   |   29.1   |      996      |      64.44       |
+| 2024-10-11T18:00:00 |   -74.9   |   28.8   |      997      |      54.09       |
+| 2024-10-12T00:00:00 |   -73.5   |   29.0   |      999      |      51.79       |
+| 2024-10-12T06:00:00 |   -72.0   |   29.2   |      1000     |      43.73       |
+| 2024-10-12T12:00:00 |   -70.5   |   29.7   |      1002     |      41.43       |
+| 2024-10-12T18:00:00 |   -69.0   |   30.5   |      1003     |      44.88       |
+| 2024-10-13T00:00:00 |   -67.0   |   31.3   |      1005     |      39.13       |
+| 2024-10-13T06:00:00 |   -64.6   |   31.8   |      1006     |      32.22       |
+| 2024-10-13T12:00:00 |   -62.0   |   32.2   |      1009     |      33.37       |
+| 2024-10-13T18:00:00 |   -59.5   |   32.1   |      1009     |      31.07       |
+| 2024-10-14T00:00:00 |   -57.2   |   32.3   |      1012     |      29.92       |
+| 2024-10-14T06:00:00 |   -55.3   |   32.0   |      1012     |      27.62       |
+| 2024-10-14T12:00:00 |   -54.9   |   30.9   |      1015     |      28.77       |
+| 2024-10-14T18:00:00 |   -54.4   |   30.0   |      1014     |      27.62       |
+| 2024-10-15T00:00:00 |   -54.0   |   29.5   |      1016     |      26.47       |
+| 2024-10-15T06:00:00 |   -54.0   |   29.4   |      1014     |      23.02       |
+| 2024-10-15T12:00:00 |   -53.9   |   29.7   |      1016     |      21.86       |
+| 2024-10-15T18:00:00 |   -53.6   |   30.3   |      1013     |      21.86       |
+| 2024-10-16T00:00:00 |   -53.0   |   31.4   |      1014     |      23.02       |
+| 2024-10-16T06:00:00 |   -52.1   |   32.7   |      1012     |      21.86       |
+| 2024-10-16T12:00:00 |   -50.9   |   34.5   |      1010     |      24.17       |
+| 2024-10-16T18:00:00 |   -48.6   |   37.2   |      1007     |      33.37       |
+| 2024-10-17T00:00:00 |   -45.1   |   40.3   |      1006     |      40.28       |
+| 2024-10-17T06:00:00 |   -40.3   |   42.7   |      1004     |      46.03       |
+| 2024-10-17T12:00:00 |   -36.2   |   44.4   |      1004     |      44.88       |
+| 2024-10-17T18:00:00 |   -32.3   |   46.2   |      999      |      42.58       |
+| 2024-10-18T00:00:00 |   -29.0   |   48.2   |      995      |      39.13       |
++---------------------+-----------+----------+---------------+------------------+
+```
+
+### Example 8: Request all active systems
+This example demonstrates the ability to retrieve all active storms in the Atlantic basin. The data is returned in tabular format, but optionally can be requested in a machine-readable json format.
+```bash
+$ metget adeck --storm all --model AVNO --cycle 2024-10-08
++-------+-------------------+------------------+------------------------+---------------------------+
+| Storm | Current Longitude | Current Latitude | Min Fcst Pressure (mb) | Max Fcst Wind Speed (mph) |
++-------+-------------------+------------------+------------------------+---------------------------+
+|   13  |       -42.7       |       17.7       |          982           |           57.54           |
+|   14  |       -90.5       |       21.8       |          955           |           96.67           |
++-------+-------------------+------------------+------------------------+---------------------------+
+```
+
 ### Custom Applications
 The MetGet client library (`MetGetBuildRest`) can be imported and used in custom applications. The below example shows how to use the
 client application in a custom Python script. Below is a simple version of how the main client application interacts with the `metget-client` library.