Doc/eficas_presentation.rst

   1 What's Eficas
   2 ==============
   3
   4 Name's origin
   5 -------------
   6 Eficas is the acronym of ' **E**\ diteur de **FI**\ chier de **C**\ ommandes et **A**\ nalyseur **S**\ émantique'.
   7 That means that Eficas allows users to write a parameter file for a code.
   8 It handles with syntax and semantic.
   9 It avoids misuse of commands which are not allowed in a given context.
  10 It insures integrity of the file.
  11
  12 General Behaviour
  13 ------------------
  14 * Catalogs
  15
  16 Eficas can be used by multiple codes and handles with multiple versions of each code. It is customized with files named "Catalogs (or Catalogues)" : It contains all commands for a code.  Each command has a name and parameters which are defined by developpers.
  17
  18
  19 * Outputs
  20
  21 Eficas's output is a commands file (dataset file or Jeux De Données)  ".comm". It may be able to produce various file formats such as .xml, .py or specific format. However, you always must have a '.comm" output: this is the only format Eficas is able to reread.
  22
  23 Both commands Files and Catalogs are python file. So you have to remind some
  24 :ref:`python-label`
  25
  26