Skip to content

Commit c7e9b58

Browse files
authored
Update README; add pyproject fields (#15)
* update readme * update pyproject toml
1 parent 4691590 commit c7e9b58

File tree

2 files changed

+23
-9
lines changed

2 files changed

+23
-9
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,24 @@
44

55
## Manifesto
66

7-
- I don't like the [Nearshore Wave Prediction System (NWPS) model viewer](https://polar.ncep.noaa.gov/nwps/nwpsloop.php?site=MTR&loop=sigwaveheight&cg=3)
8-
because you have to click through the frames and it is difficult to get a numerical value for the wave height.
9-
- I don't like [Windy](https://www.windy.com/36.616/-121.889/gfsWaves/waves?gfs,36.515,-121.898,11) because the forecasts don't make much sense
10-
between dive sites; why is a 6 ft swell at Breakwater no big deal, but a 6 ft swell at Monastery un-divable?!
7+
- The [Nearshore Wave Prediction System (NWPS) model](https://polar.ncep.noaa.gov/nwps/nwpsloop.php?site=MTR&loop=sigwaveheight&cg=3)
8+
has high-resolution data and is quite accurate because it uses a sophisticated nearshore wave model.
9+
However, I don't like the user interface; you have to click through individual frames and it is difficult to get numerical values.
10+
- [Windy](https://www.windy.com/36.616/-121.889/gfsWaves/waves?gfs,36.515,-121.898,11) has a great user interface that also displays wind, tides, etc.
11+
However, the data doesn't feel very accurate since forecasts don't make much sense between dive sites; why is a 6 ft swell at Breakwater no big deal, but a 6 ft swell at Monastery un-divable?!
1112

1213
**The goal of this project is to combine the accuracy of NWPS with the user interface of Windy.**
1314

1415
## Summary
1516

1617
The wave and swell forecast data for [NWPS](https://polar.ncep.noaa.gov/nwps/) is obtained from https://nomads.ncep.noaa.gov/.
1718
The map visuals were kept largely intact, with the major modifications being zooming into the Monterey peninsula, and adding a slider to scrub through time.
18-
A graph was added to plot the wave height over time for two dive sites, Breakwater (San Carlos beach) and Monastery beach.
19-
Similar to Windy's user interface, this can be useful for tracking how conditions for a particular site develop over time.
19+
A graph was added to plot the wave height over time for two dive sites, [Breakwater (San Carlos beach)](https://maps.app.goo.gl/wHzyiZY1mi4THkto8) and [Monastery beach](https://maps.app.goo.gl/nZdXUZvYriEUVF8z9).
20+
Similar to Windy's user interface, this is useful for tracking how conditions for a particular site develop over time.
2021

21-
We use [basemap-data-hires](https://matplotlib.org/basemap/stable/) to render the coastline map.
22+
The website updates twice a day, when data for new NWPS runs are available.
23+
24+
We use [basemap](https://matplotlib.org/basemap/stable/) to render the coastline map.
2225

2326
## Local Development
2427

@@ -32,7 +35,7 @@ uv sync
3235
To generate the webpage,
3336

3437
```
35-
uv run main.py
38+
uv run -m wavey
3639
```
3740

3841
This will create a directory "_site/" which contains the webpage.

pyproject.toml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
[project]
22
name = "wavey"
33
version = "0.1.0"
4-
description = "Add your description here"
4+
authors = [
5+
{name = "Kevin Chen"},
6+
]
7+
description = "Visualizing nearshore wave forecasts for Monterey scuba diving"
58
readme = "README.md"
9+
license = "MIT"
10+
classifiers = [
11+
"Development Status :: 3 - Alpha",
12+
"Programming Language :: Python :: 3",
13+
"Programming Language :: Python :: 3.12",
14+
"Programming Language :: Python :: 3.13",
15+
"Programming Language :: Python :: 3.14",
16+
]
617
requires-python = ">=3.12"
718
dependencies = [
819
"basemap",

0 commit comments

Comments
 (0)