Skip to content

Commit bb24805

Browse files
author
emason
committed
README.md edited online with Bitbucket
1 parent d18295a commit bb24805

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,24 @@
22

33
### How do I get set up? ###
44

5-
To avoid problem with installation, maybe prefer virtual environnement.
5+
To avoid problems with installation, use of the virtualenv Python virtual environment is recommended.
6+
7+
Then use pip to install all dependencies (numpy, scipy, matplotlib, netCDF4, cython, pyproj, Shapely, ...), e.g.:
68

79
* ** pip install cython **
10+
11+
Then run the following to install the eddy tracker:
12+
813
* ** python setup.py install**
14+
15+
Two executables are now available in your PATH: EddyIdentification and EddyTracking
16+
17+
Edit the corresponding yaml files and then run the code, e.g.:
18+
19+
* ** EddyIdentification eddy_identification.yaml**
20+
21+
for identification, followed by:
22+
23+
* ** EddyTracking tracking.yaml**
24+
25+
for tracking.

0 commit comments

Comments
 (0)