====================================================================
Naming convention RiverLab
====================================================================

24-4-2019	Aukje Spruyt
--------------------------------------------------------------------

This text file  describes the conventions that should be used for 
storing RiverLab models.

====================================================================
Folder structure:
====================================================================
Schematic test cases are stored in the directory: 'schematic'.
Real world models are stored in the directory: 'real_world'.

====================================================================
Naming convention of a real world model
====================================================================
Within the directory 'real_world' a seperate folder should be made 
for different areas. For example if you add a new model of the Danube, 
you should store it in a new folder 'Danube'.
It is upon the user to maybe add subfolders for subareas.

The name of a real_world model should have the following set up 
(preferably all lowercase, to avoid problems with Linux/Windows):

<model-type>-<area>-<description>-<version>

<model-type>: 
Type of model for example:

dflowfm1d	: D-Flow FM 1D model
dflowfm2d	: D-Flow FM 2D model
dflowfm3d	: D-Flow FM 3D model
sobek3		: SOBEK3-model
delft3d_4	: Delft3D 4-model

<area>
Name of the area that is covered in the model

<description>
Short description of the model. For example including the year that 
is represented with the geometry, with or without morphology, special 
features etc.

<version>
Version of the model. There is also a revision number assigned by the 
version control software (SVN). Version should therfore only be updated when 
there are major changes in the model and you want to also keep the old model available.

--------------------------------------------------------------------
Example:
[\real_world\waal_river\dflowfm1d-waal-j17_100year_mor-v1]

--------------------------------------------------------------------
Provide a clear description of the model in a seperate document (in the directory 'doc'). 
This description should contain:
  - Description of the area that is covered by the model (including xy-coordinates combined with a coordinate system)
  - Version number of the software that is suitable to run the model.
  - Intended use of the model (hydrodynamics, morpholgy, short-term/long term etc.)


====================================================================
Naming convention of a schematic model
====================================================================

The schematic models are stored based on the functionlity they are intended to test.
A folder [f] contains (multiple) testcases [c] for a specific functionality
\f[#]_[name]\c[#]_name

If you add a new one, replace # with the next number in the folder 
(e.g. if the previous was names 'f20_openchannelflow' then yours will 
begin with 'f21_...'). Use a descriptive name.

The testcases should also be numbered. Each testcase should have at least the following data: 
the Delft3D FM model files (input only, no output!) and the validation document. 
All model files are stored in this directory.

The (LaTeX) source code of the validation document should be stored in the directory 'doc' within each test case.
Each testcase validates a certain claim about (a newly implemented part of) the software.
The validation document details the purpose of this testcase, the linked claims, the test approach, model setup, results and conclusions.
Preferably also (Matlab/Python) scripts that are used to generate figures for the validation document are stored here.

---------------------------------------------------------------------
Example:
[\schematic\f29_mor1d2d_morfologie\c01_uniform_sediment]