doc/ref/yacs.dox

   1 //----------------------------------------------------------------------------------
   2 /*!
   3 // \file    yacs.dox
   4 // \author  Christian Caremoli
   5 // \date    2006-11
   6 */
   7 //----------------------------------------------------------------------------------
   8
   9 /*!
  10 \mainpage
  11
  12  \section Introduction
  13
  14  \b %YACS is a tool to supervise execution of complex interconnected
  15  scientific applications on computer networks and clusters.
  16  Interconnected scientific applications can be seen as a collection
  17  of computational tasks that are executed in a known order.
  18
  19  In %YACS such a kind of application is described by a calculation schema.
  20  %A calculation schema can be defined with an XML syntax and is mainly
  21  a graph of nodes that refer to computational tasks or control structures.
  22  Nodes are connected by control and data flow links.
  23
  24  \section Features
  25
  26  - Build calculation schemas from XML files
  27  - Execute calculation schema (batch, step by step)
  28  - Can manage mainly Salome component nodes, inline python nodes but
  29    also to a lesser extent : C++ component nodes, XML component nodes
  30
  31  \section Packages
  32
  33  %YACS is composed of several packages
  34  - \subpage bases : common base classes (threads,...) and constants
  35  - \subpage engine : calculation schema generic classes (calculation nodes, control nodes,
  36    control and data flow links, ...)
  37  - \subpage runtime : implementation of generic calculation nodes for Salome platform
  38  - \subpage xml_loader : XML reader for generic calculation schema
  39  - \subpage gui_design : Graphic User Interface design
  40
  41  A Python API is provided by wrapping with swig : \subpage python
  42
  43  \section Building
  44
  45  For building %YACS, you need some prerequisites
  46  - g++ 4.1 or more (mandatory)
  47  - libxml2 (mandatory)
  48  - omniorb 4.1 or more (mandatory)
  49  - python 2.3 and + (mandatory)
  50  - swig 1.3.31 (mandatory)
  51  - cppunits (optional, for unit tests only)
  52  - Salome 4.1.x (optional)
  53
  54  If you want to install %YACS for SALOME, you need to set environment
  55  variable: \b KERNEL_ROOT_DIR.
  56
  57  If you want to install %YACS with SALOME GUI, you need to set environment
  58  variable: \b GUI_ROOT_DIR.
  59
  60  The building process is the traditional cmake/make/make install:
  61  - cmake -DCMAKE_INSTALL_PREFIX=path_to_install ../src_path
  62  - make
  63
  64  Then you can run unit tests if cppunits is installed :
  65  - make test
  66
  67  Then you can run a small demo in Demo directory:
  68  - cd Demo
  69  - make
  70  - launch the echoSrv server : ./echoSrv& (if the omniorb name server is not
  71    running you need to launch it : omniNames -start -logdir /tmp & should be enough)
  72  - run yacs supervisor with the schema.xml file : ../src/yacsloader/driver schema.xml
  73
  74  Finally you can install yacs:
  75  - make install
  76  - read the doc in doc directory
  77  - go to src/yacsloader/samples directory for XML examples
  78
  79   \section TODOs
  80
  81  Many things but mainly:
  82  - add resource management features
  83  - add GUIs
  84
  85 */
  86
  87 /*! \defgroup TypeCodes  TypeCodes
  88  */
  89
  90 /*! \defgroup Nodes  Nodes
  91  */
  92
  93 /*! \defgroup Ports  Ports
  94  */
  95
  96 /*! \defgroup AdaptorPorts AdaptorPorts
  97  */
  98
  99 /*! \defgroup Executors Executor objects
 100  */
 101