qgis3 port (#345)

port of plots and animations to QGIS 3.3 (master)

.gitignore

@@ -1,3 +1,4 @@
+*.DS_Store
 *.user
 *.user.*
 build-*

README.md

@@ -5,115 +5,18 @@ 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](https://en.wikipedia.org/wiki/NetCDF): Generic format for scientific data. Examples can be found [here](http://apps.ecmwf.int/datasets/data/interim-full-daily/levtype=sfc/)
-- [GRIB](https://en.wikipedia.org/wiki/GRIB): Format commonly used in meteorology. Examples can be found [here](http://apps.ecmwf.int/datasets/data/interim-full-daily/levtype=sfc/)
-- [XMDF](https://en.wikipedia.org/wiki/XMDF): As an example, hydraulic outputs from TUFLOW modelling package
-- [SWW](http://anuga.anu.edu.au/): Outputs of the ANUGA modelling package
-- [DAT](http://www.xmswiki.com/wiki/SMS:ASCII_Dataset_Files_*.dat): Outputs of various hydrodynamic modelling packages (e.g. BASEMENT, HYDRO_AS-2D)
-- [HEC-RAS](http://www.hec.usace.army.mil/software/hec-ras/): Outputs of the HEC-RAS modelling package
-- [Serafin files](http://www.gdal.org/drv_selafin.html): Outputs of the TELEMAC 2D hydrodynamic modelling package
-- [FLO-2D](http://www.flo-2d.com/): Outputs of the FLO-2D modelling package
-- XDMF: Generic format for scientific data.
-- [UGRID](https://github.com/ugrid-conventions/ugrid-conventions): [Delft3D Flexible Mesh Suite](https://www.deltares.nl/en/software/delft3d-flexible-mesh-suite)
-
-<img src="https://travis-ci.org/lutraconsulting/qgis-crayfish-plugin.svg?branch=master">
+You can use Crayfish to load the file formats supported by [MDAL](https://github.com/lutraconsulting/MDAL)
 
 ### Using Crayfish
 
 For instructions of how to install and use Crayfish, please refer to the [Crayfish resources page][crp] 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:
-
-```bash
-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:
-
-```bash
-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:
-
-```bash
-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`):
-
-```bash
-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
-```
+Use QGIS3 plugin manager to install latest crayfish version.
 
 [crp]: http://www.lutraconsulting.co.uk/resources/crayfish
 
-### Running tests
+### Developement 
 
-* Install all dependencies
-```bash
-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
-```bash
-cd qgis-crayfish-plugin/corelib
-export QT_SELECT=qt4
-qmake
-make
-```
-* Run tests
-```bash
-cd qgis-crayfish-plugin/test
-nosetests
-```
+building of resources files `pyrcc5 -o resources.py resources.qrc`