Skip to content

Commit 48b50f9

Browse files
committed
doc update
1 parent 17db20b commit 48b50f9

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

doc/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
Welcome to py-eddy-tracker's documentation!
77
===========================================
88

9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Installation
12+
13+
installation
14+
915
.. toctree::
1016
:maxdepth: 2
1117
:caption: Grid manipulation

doc/installation.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
=====================
2+
How do I get set up ?
3+
=====================
4+
5+
Source are available on github https://github.com/AntSimi/py-eddy-tracker
6+
7+
Use python3.
8+
To avoid problems with installation, use of the virtualenv Python virtual environment is recommended or conda.
9+
10+
Then use pip to install all dependencies (numpy, scipy, matplotlib, netCDF4, pyproj, ...), e.g.:
11+
12+
.. code-block:: bash
13+
14+
pip install numpy scipy netCDF4 matplotlib opencv-python pyyaml pyproj pint polygon3
15+
16+
17+
Then run the following to install the eddy tracker:
18+
19+
.. code-block:: bash
20+
21+
python setup.py install
22+
23+
Several executables are available in your PATH:
24+
25+
.. code-block:: bash
26+
27+
GridFiltering # Allow to apply a high frequency filter on a NetCDF grid
28+
EddyId # Provide identification of eddies for one grid
29+
EddySubSetter # Allow to apply sub setting on eddies dataset
30+
EddyTracking # Allow to track Identification dataset

0 commit comments

Comments
 (0)