Crayfish (QGIS plugin)

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

You can use Crayfish to load the following file formats in QGIS:

• NetCDF: Generic format for scientific data. Examples can be found here
• GRIB: Format commonly used in meteorology. Examples can be found here
• XMDF: As an example, hydraulic outputs from TUFLOW modelling package
• SWW: Outputs of the ANUGA modelling package
• DAT: Outputs of various hydrodynamic modelling packages (e.g. BASEMENT, HYDRO_AS-2D)
• HEC-RAS: Outputs of the HEC-RAS modelling package
• Serafin files: Outputs of the TELEMAC 2D hydrodynamic modelling package
• FLO-2D: Outputs of the FLO-2D modelling package

Using Crayfish

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

Installing

Installing Crayfish on Linux

For installing Crayfish on Linux you need:

• development environment and a compiler installed
• Qt4 and development tools
• HDF5 library (for XMDF format)
• NetCDF library (for AnuGA SWW format)
• GDAL library

On Debian/Ubuntu you need to install the following packages:

sudo apt-get install build-essential libqt4-dev qt4-qmake libgdal-dev libhdf5-dev libnetcdf-dev libproj-dev git

For Red Hat/Cent OS/Fedora, the following command will install the required packages:

sudo dnf install gcc-c++ make qt-devel gdal-libs hdf5-devel netcdf-devel proj-devel git
sudo dnf install python sip-devel gdal-devel pyqt4

If all these packages are installed you can clone the crayfish plugin using the command:

git clone https://github.com/lutraconsulting/qgis-crayfish-plugin.git

After cloning the source you should run the installation script which compiles and installs everything to user's QGIS python plugin directory (~/.qgis2/python/plugins/crayfish):

cd qgis-crayfish-plugin
export QT_SELECT=qt4
./install.py

Now restart QGIS and you are able to use crayfish plugin on your Linux Computer.

Installing Crayfish on Windows

For 32-bit version:

• Install Microsoft Visual Studio 2008
• Install OSGeo4W (32bit) to C:\OSGeo4W
• Run scripts\crayfish32.bat to build the crayfish DLL

For 64-bit version:

• Install Microsoft Visual Studio 2010
• Install OSGeo4W (64bit) to C:\OSGeo4W64
• Run scripts\crayfish64.bat to build the crayfish DLL

Installing Crayfish on Mac-OS (Experimental)

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install pyqt
mkdir -p /Users/XXX/Library/Python/2.7/lib/python/site-packages
echo 'import site; site.addsitedir("/usr/local/lib/python2.7/site-packages")' >> /Users/XXX/Library/Python/2.7/lib/python/site-packages/homebrew.pth
brew install sip
brew install homebrew/dupes/make
brew install gdal
brew install homebrew/science/hdf5
brew install homebrew/science/netcdf

Running tests

• Install all dependancies

sudo apt-get install build-essential libqt4-dev qt4-qmake libgdal-dev libhdf5-serial-dev libproj-dev qgis
sudo apt-get install python python-sip python-qt4 python-numpy python-qgis python-nose

• Compile crayfish library

cd qgis-crayfish-plugin/corelib
export QT_SELECT=qt4
qmake
make

• Run tests

cd qgis-crayfish-plugin/test
nosetests