Visualiser for temporal structured and unstructured grids in QGIS.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
crayfish packaging stuff Sep 27, 2018
.gitattributes Added .gitattributes Oct 16, 2012
.gitignore qgis3 port (#345) Sep 27, 2018
LICENSE.txt Add GPL License file Nov 6, 2017
README.md improve docs Sep 27, 2018
install_dev.sh qgis3 port (#345) Sep 27, 2018
package.bash packaging stuff Sep 27, 2018
resources.bash packaging stuff Sep 27, 2018

README.md

Crayfish (QGIS plugin)

The Crayfish Plugin is a visualiser for temporal structured/unstructured grids in QGIS.

You can use Crayfish to load the file formats supported by MDAL

Works on Windows, Linux and MacOS.

Crayfish 3 vs Crayfish 2

In QGIS 2.x & Crayfish 2.x all features were implemented through QGIS's plugin layer. Rendering and format reading were written in C++ language and hence Crayfish 2 was shipped as C++ library and QGIS python plugin.

In QGIS 3.4 & Crayfish 3.x, the C++ library was abandon and replaced by MDAL data provider for data (format) reading and QGIS Core enhancement (QgsMeshLayer).

Here is the table that helps to understand where the implementation was moved and where to report issues with Crayfish:

MDAL QGIS 3.x Crayfish 3.x
grid input X
data input X
rendering X
identify X
styling X
time slider X
export grid X*
export contours X*
trace animation X*
plots X
export animations X

* marks not implemented features

Using Crayfish

For instructions of how to install and use Crayfish, please refer to the Crayfish resources page on our website.

  • load mesh layer with data source manager in QGIS
  • load datasets from properties panel in QGIS
  • style and browse with styling panel (f7)
  • use plots and export animations with Crayfish plugin

Installing

Use QGIS3 plugin manager to install latest crayfish version.

Developement

Please refer to QGIS official plugin development cookbook and practises.