wiki:ProjectDocumentation

Version 40 (modified by sommeria, 6 years ago) (diff)

--

Project Name

InfrastructureCNRS_Coriolis
Project title (long )..........
Short title - name of the data folderproject name
Lead Author name...............
Contributor name (add lines for each)............
Date Campaign Start.........
Date Campaign End...........

0 - Publications, reports from the project

1 - Objectives

This is a template for the documentation of an experimental project.

  • It is first needed as a common notebook for the research team.
  • It is eventually aimed to be used as a documentation for the published data.
  •  The wiki format is convenient for collaborative projects, as it can be easily accessed from the web, and it manages and keeps track of the successive modifications by several authors. The wiki relies on a few simple editing conventions. This template can be however used with other editing methods.

2 - Experimental setup

2.1 General description

include sketches, photos, ...

(to attach figures or files, leave the editor and press the button 'Attach file' at the bottom of the edit window.

Then use coriolis_sketch.jpg? to put it in the text.

2.2 Definition of the coordinate system

Define  the coordinate system $(x,y,z)$ used to identify points on images and probe locations. Think from the beginning at the most rational choice for the final publication of the data, so that no change is needed which may lead to ambiguities in data description. If several coordinate sets need to be used, define precisely their links.

2.3 Relevant fixed parameters:

Notation DefintionValueremarks
Htotal water heightH=80 cm.....
Wchannel widthL=150 cm.....
$\alpha$slope angle$\alpha$=20 degrees.....

2.4 Definition of the variable control parameters

parameter values to be given for each experiment in section

Notation DefinitionUnitremarks
Param1
Param2
Param3

2.5 Definition of the relevant non-dimensional numbers

define here the derived parameters of interest, in particular non-dimensional numbers.

3 Instrumentation and data acquisition

3.1 Instruments

with positions of probes, cameras...

3.2 Definition of time origin and instrument synchronisation

3.3 Requested final output and statistics

4 - Methods of calibration and data processing

5 - Organisation of data files

All data related to the project are in Coriolis /.fsnet/project/coriolis/2014/'project name'

  • 0_DOC: miscellaneous documentation and reports
  • 0_MATLAB_FCT: specific matlab functions
  • 0_PHOTOS: photos of set-up
  • 0_REF_FILES: files of general use (calibration data, grids ...)
  • 0_RESULTS: processed data (time series, statistics...) and figures.
  • EXP1, EXP2, folder for each experiment. Structure of each Experiment folder:
    • DeviceFolder: corresponding to the data of a given instrument or camera.
    • Results from data processing are stored in a folder DeviceFolder.ext where ext is set by the processing program.
    • An xml file named DeviceFolder.xml specifies information from the devices, for instance timing and calibration parameters for an image series.

6 - Table of experiments

List of parameter, Param1... , denoted by names defined in section 4.2.

NameDateParam1Param2Param3Remarks
#EXP1
#EXP2
#EXP3

7 - Diary:

EXP1

EXP2

EXP3

Attachments (2)

Download all attachments as: .zip