#### FullSWOF-transfer_UI
#### version 1.00.00, 2023-03-14
#### Compatible with FullSWOF_1D-transfer Version 2.00.00.
#### Contributors: Aloïs Kernaonet (2022)
####               Maxime Lacourte (2022)
####               Frédéric Darboux (2022) frederic.darboux@inrae.fr
####               Carine Lucas (2023) carine.lucas@univ-orleans.fr

FullSWOF-transfer_UI stands for ``Full Shallow Water equations for Overland Flow, transfer equations. User Interface''. It is a graphical user interface for the transfer equations of FullSWOF_1D (see <https://sourcesup.renater.fr/projects/fullswof-1d/>). It helps in creating the transfer input file.

##############################
Users
##############################

Download the latest <jar-file> (that is the file with the .jar extension) of FullSWOF-transfer_UI 	from: <https://sourcesup.renater.fr/frs/?group_id=997>
Launch FullSWOF_UI using:
	java -jar <jar-file> 
Extra documentation is available at:
	<https://sourcesup.renater.fr/docman/?group_id=997>
Contact information: <https://sourcesup.renater.fr/projects/fullswof-ui/>


##############################
Developers
##############################

Download the source code package (that is the file with the .zip extension) from: 
	<https://sourcesup.renater.fr/frs/?group_id=997>
Please contribute to the software through the SVN repository:
	<https://sourcesup.renater.fr/scm/?group_id=997>
You can use the build.xml file with ant (run "ant clean" and "ant") to create the .jar file.
Contact information: <https://sourcesup.renater.fr/projects/fullswof-ui/>

---------- Doxygen -----------

Note: To simplify these operations, you can run the script UpdateDateVersion located in the bin folder.

In order to generate the Doxygen html file, the Doxygen_config_file_html file is saved in the main directory.
To run Doxygen, from the main directory, use the command:

doxygen Doxygen_config_file_html

Warning: Graphviz (http://www.graphviz.org/) must be in your PATH to generate HTML diagrams. 
If not, change the HAVE_DOT parameter of the Doxygen_config_file_html.

=> In the doc/html/ directory, index.html is created.

To generate the Doxygen latex (pdf) file, you must use the Doxygen_config_file_latex file and compile the tex file:

doxygen Doxygen_config_file_latex
cd doc/latex
make

=> In the doc/latex directory, refman.pdf is created.

##############################
License
##############################

This software is distributed under CeCILL-V2 (GPL compatible) free software license
(see <http://www.cecill.info/licences/Licence_CeCILL_V2-en.html>).

This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use, 
modify and/or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info". 

As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability. 

In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or 
data to be ensured and, more generally, to use and operate it in the 
same conditions as regards security. 

The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.

FullSWOF-transfer_UI includes binary packages from ANTLR v3 and jReality

###################################################

ANTLR

Copyright (c) 2010 Terence Parr
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

###################################################

jReality

Copyright (c) 2003-2006, jReality Group: Charles Gunn, Tim Hoffmann, Markus Schmies, Steffen Weissmann
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of jReality nor the names of its contributors nor the names of their associated organizations may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.