Skip to content

Commit 523994c

Browse files
committed
DOC: examples/ > README.md: added cross-references to example-files.
1 parent fd21df1 commit 523994c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

examples/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# EMMA: Examples
22
Five examples have been included to aid in the usage of `EMMA`:
3-
1. **Basic, single-file usage.**
3+
1. [**Basic, single-file usage.**](1_basic.py)
44
The most basic usage of `EMMA` using a single map-file.
55

6-
1. **Parallel, multi-file usage.**
6+
1. [**Parallel, multi-file usage.**](2_parallel.py)
77
Parallel usage of `EMMA` using multiple map-files.
88

9-
1. **Added physical data.**
9+
1. [**Added physical data.**](3_settings.py)
1010
Improved accuracy of `EMMA` by providing additional data, such as tidal characteristics.
1111

12-
1. **Export output data.**
12+
1. [**Export output data.**](4_export.py)
1313
Export the ecotope-map determined by `EMMA` to a `*.csv`-file.
1414

15-
1. **Customising configurations.**
15+
1. [**Customising configurations.**](5_config.py)
1616
Customising the configuration of the ecotope-labels and/or the keywords in the hydrodynamic output data. This means
1717
overwriting (part of) the configurations files (i.e., the `*.json`-files in the [`config`](../config)-folder).
1818

0 commit comments

Comments
 (0)