Skip to content

Commit 02bc44d

Browse files
committed
Add some information about tracking
1 parent b569aee commit 02bc44d

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

doc/run_tracking.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,26 @@
22
Tracking
33
========
44

5+
Requirements
6+
************
7+
8+
Before to run tracking, you will need to run identification on every time step of the period(Period of your study).
9+
10+
**Advice** : Before to run tracking, display some identification file allow to learn a lot
511

612
Default method
713
**************
814

915
To run a tracking just create an yaml file with minimal specification (*FILES_PATTERN* and *SAVE_DIR*).
16+
You will run tracking separately between Cyclonic eddies and Anticyclonic eddies.
1017

11-
Example of yaml
18+
Example of conf.yaml
1219

1320
.. code-block:: yaml
1421
1522
PATHS:
1623
# Files produces with EddyIdentification
17-
FILES_PATTERN: MY/IDENTIFICATION_PATH/Anticyclonic*.nc
24+
FILES_PATTERN: MY_IDENTIFICATION_PATH/Anticyclonic*.nc
1825
SAVE_DIR: MY_OUTPUT_PATH
1926
2027
# Number of timestep for missing detection
@@ -39,8 +46,8 @@ It will produce 4 files by run:
3946

4047
- A file of correspondances which will contains all the information to merge all identifications file
4148
- A file which will contains all the observations which are alone
42-
- A file which will contains all the short track which are shorter than TRACK_DURATION_MIN
43-
- A file which will contains all the long track which are longer than TRACK_DURATION_MIN
49+
- A file which will contains all the short track which are shorter than **TRACK_DURATION_MIN**
50+
- A file which will contains all the long track which are longer than **TRACK_DURATION_MIN**
4451

4552

4653
Choose a tracker

0 commit comments

Comments
 (0)