------------------------------------------------------------------------

#

Copyright (C) 1985-2020 Georg Umgiesser

#

This file is part of SHYFEM.

#

SHYFEM is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

#

SHYFEM is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.

#

You should have received a copy of the GNU General Public License

along with SHYFEM. Please see the file COPYING in the main directory.

If not, see http://www.gnu.org/licenses/.

#

------------------------------------------------------------------------

This is the README file for the SHYFEM model

------------------------------------------------------------------------

Contact:

Georg Umgiesser
Oceanography, ISMAR-CNR
Arsenale Tesa 104, Castello 2737/F
30122 Venezia
Italy

Tel.   : +39-041-2407943
Fax    : +39-041-2407940
E-Mail : georg.umgiesser@ismar.cnr.it

------------------------------------------------------------------------

Availability:

https://github.com/SHYFEM-model/

Comments and issues should be posted in the Issues section 
on the abovementioned GitHub repository

------------------------------------------------------------------------

Documentation:

The manual can be found in femdoc/final/shyfem.pdf

Example applications can be found in examples

------------------------------------------------------------------------

The software is also supported by various institutions:

CNR - ISMAR (Istituto di Scienze Marine)
---------
Georg Umgiesser, system engineering
Christian Ferrarin, renewal times, sediment transport
Marco Bajo, system solvers, assimilation
Debora Bellafiore, non-hydrostatic modeling, fluid mud
Michol Ghezzo, ecological modeling, lagrangian model, connectivity
Francesca De Pascalis, lagrangian model
William McKiver, non-hydrostatic modeling

CNR - IAS (Istituto di Ambiente Marino Costiero)
---------
Andrea Cucco, lagrangian model, renewal times

INOGS (Istituto Nazionale di Oceanografia e di Geofisica Sperimentale)
---------
Cosimo Solidoro, ecological modeling, BFM
Donata Melaku Canu, ecological modeling, EUTRO
Eric Pascolo, OMP parallelization

MRI (Marine Research Institute, Klaipeda University, Lithuania)
---------
Petras Zemlys, ecological modeling, AquaBC

Istanbul University
---------
Ali Erturk, ecological modeling, AquaBC

Fondazione CMCC (Centro Mediterraneno per i cambiamenti climatici)
---------
Silvia Mocavero, MPI parallization
Giorgio Micaletto, MPI parallization

------------------------------------------------------------------------

Directory structure

examples example applications fem3d FEM model and utility routines femadj Routines for the adjustment of the grid after the automatic mesh generation. The program to run is shyadj. femanim Routines to generate animations from postscript files fembin Binaries used by the model femcheck Routines to set up and check the installation femdoc Documentation, manual, etc. femdummy Dummy directory femersem Routines for BFM (ERSEM) ecological model femgotm Routines for GOTM turbulence clousre model femlib Library routines (populated during compilation) femplot Plotting routines for post processing. The routine to run is shyplot. femregres Routines to do regression testing. Developers only. femutil Various utility programs grid Visualization routine for GRD files hcbs Outdated files for plotting to monitor mesh Automatic mesh generator post Library for plotting to Postscript files. tmp Temporary directory

Compiling the model

You can compile everything from the SHYFEM directory by running the command "make fem". Other commands are:

make help gives help on available make targets make fem compiles everything make doc makes documentation in femdoc (manual) make all compiles (shyfem) and makes documents (doc) make clean deletes objetc and executable files in all subdirectories make cleanall as clean, but cleans also libraries

------------------------------------------------------------------------