Skip to content

Latest commit

 

History

History

examples

README.md

EMMA: Examples

The examples include a simple visualisation function that uses matplotlib. If not installed, please do so:

python3 -m pip install matplotlib

Instead of installing separately, EMMA could also be installed with the option examples automatically installing matplotlib as well:

python3 -m pip install .[examples]

Five examples have been included to aid in the usage of EMMA:

  1. Basic, single-file usage. The most basic usage of EMMA using a single map-file.

  2. Parallel, multi-file usage. Parallel usage of EMMA using multiple map-files.

  3. Added physical data. Improved accuracy of EMMA by providing additional data, such as tidal characteristics.

  4. Export output data. Export the ecotope-map determined by EMMA to a *.csv-file.

  5. Customising configurations. Customising the configuration of the ecotope-labels and/or the keywords in the hydrodynamic output data. This means overwriting (part of) the configurations files (i.e., the *.json-files in the config-folder).

All examples make use of a basic plot-function to visualise the results. This function can also be used as a starting point for visualising the ecotope-maps.

To work with the examples, a dummy output-file is included in this folder. Note that for the parallel, multi-file usage-example, there is no enhanced computation time for single-file usage due to the implementation of parallel computing, which is file-based. Nevertheless, the use-case described in parallel, multi-file usage also works with a single map-file.

Note that the data in the dummy output-file is dummy data, provided to aid in familiarising with EMMA. As such, it should not be used for any official analysis and alike.