Skip to content

Commit 3ae69e1

Browse files
committed
update readme
1 parent e2289fa commit 3ae69e1

File tree

3 files changed

+56
-5
lines changed

3 files changed

+56
-5
lines changed

README.md

Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,71 @@ To avoid problems with installation, use of the virtualenv Python virtual enviro
66

77
Then use pip to install all dependencies (numpy, scipy, matplotlib, netCDF4, cython, pyproj, Shapely, ...), e.g.:
88

9-
* ** pip install cython numpy matplotlib scipy netCDF4 shapely pyproj**
9+
```bash
10+
pip install cython numpy matplotlib scipy netCDF4 shapely pyproj
11+
```
1012

1113
Then run the following to install the eddy tracker:
1214

13-
* ** python setup.py install**
15+
```bash
16+
python setup.py install
17+
```
1418

1519
Two executables are now available in your PATH: EddyIdentification and EddyTracking
1620

1721
Edit the corresponding yaml files and then run the code, e.g.:
1822

19-
* ** EddyIdentification eddy_identification.yaml**
23+
```bash
24+
EddyIdentification eddy_identification.yaml
25+
```
2026

2127
for identification, followed by:
2228

23-
* ** EddyTracking tracking.yaml**
29+
```bash
30+
EddyTracking tracking.yaml
31+
```
32+
33+
for tracking.
34+
35+
36+
# Py Eddy Tracker module #
37+
38+
### Grid manipulation ###
39+
40+
Loading grid
41+
```python
42+
from py_eddy_tracker.dataset.grid import RegularGridDataset
43+
h = RegularGridDataset('share/nrt_global_allsat_phy_l4_20190223_20190226.nc', 'longitude', 'latitude')
44+
```
45+
46+
Plotting grid
47+
```python
48+
fig = plt.figure(figsize=(14, 12))
49+
ax = fig.add_axes([.02, .51, .9, .45])
50+
ax.set_title('ADT (m)')
51+
ax.set_ylim(-75, 75)
52+
ax.set_aspect('equal')
53+
m=ax.pcolormesh(h.x_bounds, h.y_bounds, h.grid('adt').T.copy(), vmin=-1, vmax=1, cmap='coolwarm')
54+
ax.grid(True)
55+
plt.colorbar(m, cax=fig.add_axes([.94, .51, .01, .45]))
56+
```
57+
58+
Filtering
59+
```python
60+
h.bessel_high_filter('adt', 500, order=3)
61+
```
62+
63+
Add second plot
64+
```python
65+
ax = fig.add_axes([.03, .02, .9, .45])
66+
ax.set_title('ADT Filtered (m)')
67+
ax.set_aspect('equal')
68+
ax.set_ylim(-75, 75)
69+
m=ax.pcolormesh(h.x_bounds, h.y_bounds, h.grid('adt').T, vmin=-.1, vmax=.1, cmap='coolwarm')
70+
ax.grid(True)
71+
plt.colorbar(m, cax=fig.add_axes([.94, .02, .01, .45]))
72+
fig.savefig('share/png/filter.png')
73+
```
74+
75+
![signal filtering](share/png/filter.png)
2476

25-
for tracking.
2.77 MB
Binary file not shown.

share/png/filter.png

1.39 MB
Loading

0 commit comments

Comments
 (0)