Skip to content
This repository has been archived by the owner on Oct 21, 2024. It is now read-only.

Contribution to HOS ocean

gducrozet edited this page Feb 9, 2017 · 5 revisions

For developers/contributors to the HOS-ocean project, a GIT repository has been set-up. In order to avoid any issues concerning the main subroutines (representing the so-called High-Order Spectral method), benchmarking procedure of this main core is provided.

GIT contributions

The GitHub repository is used in other projects in LHEEA using Gerrit Code Review. As a consequence, each commit message must include

  • Change-Id line
  • Signed-off-by line

Change-Id line

Change-Ids are created at commit time on the client side. A standard commit-msg hook is provided by Gerrit, and can be installed in the local Git repository to automatically generate and insert a Change-Id line during git commit, when none is defined yet.

To install the hook, you can download it from gerrit review and copy the corresponding file to .git/hooks/

Then ensure that the execute bit is set on the hook script:

chmod u+x .git/hooks/commit-msg

Signed-off-by line

The sign-off is a simple line at the end of the explanation of the commit of the form

Signed-off-by: Random J Developer [email protected]

General recommendations

It is asked for anyone contributing to HOS core, i.e. following routines

  • resol_HOS.f90
  • variables_3D.f90
  • filters.f90
  • Makefile: especially compilation options

to run the benchmark and ensure that results are not modified.

Use of benchmark program

Benchmark program consists of two specific files with a corresponding Makefile

  • check_W_DYue.f90
  • variables_3D_DYue.f90
  • Makefile_test_W_DYue

Linux/Unix environment: the compilation of the benchmark program is made with typical instructions

make -Bf makefile_test_DYue

Windows environment: to be completed

Run and results

The program is executed in command line.

TO BE COMPLETED

Analytics