doc/integration.rst

   1 .. _integration:
   2
   3 **********************************************************
   4 Integration of components into SALOME for YACS
   5 **********************************************************
   6
   7 This part of the documentation provides information to create SALOME components that can be coupled with YACS, either
   8 starting from scratch or by including an existing code.
   9
  10 The first two chapters are tutorials to create SALOME modules with a single “Hello World” type component, implemented
  11 in Python (:ref:`pysalome`) or in C++ (:ref:`cppsalome`).
  12
  13 The next chapter (:ref:`components`) describes operations to be done to include calculation codes into the SALOME
  14 architecture.
  15 The fourth chapter (:ref:`calculator`) shows how to create a SALOME component that uses MED objects.
  16
  17 The next chapter presents a tool (:ref:`hxx2salome`) that automates much of the work to integrate a C++ calculation
  18 code, provided that only the dataflow ports are used.
  19
  20 The sixth chapter (:ref:`progdsc`) is aimed particularly at persons who would like to develop new datastream ports
  21 based on the DSC programming model.
  22
  23 The next chapter is a :ref:`calcium`. CALCIUM ports are datastream ports predefined in SALOME that simply implement
  24 datastream couplings in YACS.
  25
  26 Finally, the last chapter is a guide for use of a tool (:ref:`yacsgen`)  that automates the integration of calculation
  27 codes in Fortran, C, Python and that use CALCIUM datastream ports, that is not possible with the :ref:`hxx2salome` tool.
  28
  29 .. toctree::
  30    :maxdepth: 2
  31
  32    pysalome
  33    cppsalome
  34    components
  35    calculator
  36    hxx2salome
  37    progdsc
  38    calcium
  39    yacsgen