Home | Download/Install | Documentation | Packages | Screenshots | News | Forum/Mailing-lists | Contact | GForge

Component naming guidelines

This a draft.

Naming convention

Packages
  • The name of a package is choose by its author.
  • Do not add Py as a prefix or suffix (choose Aml rather than AmlPy)
  • You can create a meta-package with the name of your teams:
    • vplants.aml : aml is a sub-package of vplants
  • Use singular names rather than plural.
  • Use lower case.

examples :

  • catalog.data
  • demo.stand.forestry
  • vplants.plantgl
Nodes
  • Explicit is better than implicit ;
  • Use lowercase
  • Differentiate nodes by ():
    • plot2d (matplotlib), plot2d (gnuplot)
    • estimate sequence, estimate frequency, …
    • plot3d (plantgl), plot3d (vtk)

example :

  • fread ⇒ read file
  • int
  • scene

Default Category

Use category and subcategory

You can use Uppercase for category name.

  • Python
  • Data: read vs load vs import | write vs save vs export family
  • Type:
    • Type.List : ex list, range, getitem
    • Type.Dictionary : dict, getitem,
    • Type.Array : array
    • Type.Set : set
    • Type.Graph
  • Expression: eval
    • Expression.Unary,
    • Expression.Binary,
  • Function:
    • Function.1d,
    • Function.2d
  • Math
  • Stat :
    • Stat.Sequence,
    • Stat.Vector,
    • Stat.FrequencyDistribution,
  • Plot :
    • Plot.2d,
    • Plot.3d,
  • Ecophysiology :
    • Ecophysiology.Light,
    • Ecophysiology.Water,
    • Ecophysiology.Carbon,
  • Simulation
    • Simulation.Meristem,
    • Simulation.Plant,
    • Simulation.Stand,
    • Simulation.Phyllotaxy
 
documentation/component/component_naming_guidelines.txt · Last modified: 2007/10/11 14:09 by admin   Back to top
INRIA   INRA     CIRAD     AGROPOLIS
INRIA GForge RSS feed Valid XHTML 1.0 Valid CSS Driven by DokuWiki