[Stacomir-commits] r450 - pkg/stacomir

[noreply at r-forge.r-project.org]

Author: legrand
Date: 2017-08-30 16:21:32 +0200 (Wed, 30 Aug 2017)
New Revision: 450

Modified:
   pkg/stacomir/README.Rmd
   pkg/stacomir/README.md
Log:
writting the beginning of the data structure

Modified: pkg/stacomir/README.Rmd
===================================================================
--- pkg/stacomir/README.Rmd	2017-08-30 13:14:42 UTC (rev 449)
+++ pkg/stacomir/README.Rmd	2017-08-30 14:21:32 UTC (rev 450)
@@ -58,8 +58,39 @@
 
 Data structure
 -------------------    
-    
+The structure of the data contained in the open source postgresql database
+"bd_contmig_nat" is based on the following concepts.
 
+### Station
+Station is a fish migration monitoring and in general, it is considered to be a
+section of a watercourse allowing the evaluation of fish upstream or downstream
+migration.
+Station may extend to the whole section of the migration axis to evaluate a
+migratory flow on a section subdivided into several natural or artificial
+channels. A station consists physically of as many weirs as hydrographic
+sections monitored (river, channels, etc.).
+
+### Weir
+The concept of weir used in the context of fish migration monitoring database
+refers to a system blocking or guiding the migratory flow like : (i) dam, (ii)
+electric guide barrier, (iii) netting dam, etc.
+
+### Crossing device   
+A crossing device is a passageway that allows and concentrates the migratory
+flow between upstream and downstream of a weir. We can have several types like
+:(i) fishway, (ii) spillway, (iii) fish elevator, etc.
+
+It is possible to have more than one crossing device on a same weir.
+
+### Counting device
+A couting device is a set of equipment installed on a crossing devise used to
+monitor the migratory flow that passes through it.
+
+### Operation
+
+### Fishes
+
+
  Package structure
 --------------------
 

Modified: pkg/stacomir/README.md
===================================================================
--- pkg/stacomir/README.md	2017-08-30 13:14:42 UTC (rev 449)
+++ pkg/stacomir/README.md	2017-08-30 14:21:32 UTC (rev 450)
@@ -48,20 +48,53 @@
 No R package
 JAVA + postgres + R
 
-## Presentation
 
-### Data structure
-    
-    
 
-### Package structure
+Data structure
+-------------------    
+The structure of the data contained in the open source postgresql database
+"bd_contmig_nat" is based on the following concepts.
 
-###    Working examples
+### Station
+Station is a fish migration monitoring and in general, it is considered to be a
+section of a watercourse allowing the evaluation of fish upstream or downstream
+migration.
+Station may extend to the whole section of the migration axis to evaluate a
+migratory flow on a section subdivided into several natural or artificial
+channels. A station consists physically of as many weirs as hydrographic
+sections monitored (river, channels, etc.).
 
-####        Interface
+### Weir
+The concept of weir used in the context of fish migration monitoring database
+refers to a system blocking or guiding the migratory flow like : (i) dam, (ii)
+electric guide barrier, (iii) netting dam, etc.
 
-####        Command line
+### Crossing device   
+A crossing device is a passageway that allows and concentrates the migratory
+flow between upstream and downstream of a weir. We can have several types like
+:(i) fishway, (ii) spillway, (iii) fish elevator, etc.
 
+It is possible to have more than one crossing device on a same weir.
+
+### Counting device
+A couting device is a set of equipment installed on a crossing devise used to
+monitor the migratory flow that passes through it.
+
+### Operation
+
+### Fishes
+
+
+ Package structure
+--------------------
+
+Working examples
+-------------------------
+
+###        Interface
+
+###        Command line
+
 License
 -------
 Released under GPL-2.