CodingRules.org

This file provides a list of coding rules for Parmes, parmepy that MUST be applied by all developpers.

General

Documentation

Use doxygen. Todo : write a short doxygen howto Describe each function, subroutine … and all the in/out arguments.

Indentation :

GNU Style, see http://en.wikipedia.org/wiki/Indent_style tab size = 2 spaces To

Fortran

Naming ?

use .f90 for file names

use implicit none

any function, subroutine … must be in a module

Python

Naming conventions

see http://www.python.org/dev/peps/pep-0008/

use distutils (__init__.py …)

see http://docs.python.org/distutils/setupscript.html