.. image:: https://readthedocs.org/projects/flowmap/badge/?version=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/openearth/flowmap/shield.svg
Command line utility to transform model output into a flowmap that can be used for games or gpu-based visualizations.
- Free software: GNU General Public License v3
- Documentation: https://flowmap.readthedocs.io.
Scripts that generate flowmaps for specific models:
- matroos_flowmap.sh (download model results for DCSM model and transform them to a flowmap)
To use the software you can download the latest version using docker.
If you have docker installed you can download the software using the command:
.. code:: bash
docker pull openearth/flowmap
You can run the software by typing the command (for now please prepend the flowmap command with
.. code:: bash
docker run openearth/flowmap flowmap --help
docker run openearth/flowmap flowmap generate --help
docker run openearth/flowmap flowmap generate delft3doutput.nc --src_epsg=28992 --dst_epsg=3857
In the case of Delft3D you can convert the default nefis output to netCDF using the vs_trim2nc.m matlab script.
There is also direct nefis support in development, but that has not been properly tested.
By default you will want to project to the web mercator projection. Then you can reuse the velocities as pixels/s in an animation.
This package was created with Cookiecutter and the
audreyr/cookiecutter-pypackage project template.