SALOME KERNEL Reference Documentation

Welcome to the SALOME KERNEL documentation ! Following your kind of usage of SALOME, you will find some specific introductory documentation, listed below.

End user

1. How to configure a SALOME application
   The end user may have to configure his own SALOME application by selecting a subset of available SALOME modules. He may also want to install his application on several computers. See Salome Application Concept to define your own configuration of SALOME and run it on one or several computers. This is the recommended way of configuration.
2. How to launch SALOME
   Use the python salome command.
3. How to use KERNEL services in Python scripts
   The SALOME KERNEL offers a list of services available in Python. See KERNEL Services for end user (Python interface).
4. How to use KERNEL services from a C++ context
   The SALOME KERNEL provides you with helper functions to manipulate the SALOME KERNEL services from a C++ programming context. See KERNEL Services helper functions for C++ programmers.

Application Integrator

Applications integrators are in charge of configuration and installation of specific SALOME applications over a local network. Application Integrators built SALOME modules binaries from sources tarballs.

1. How to install SALOME
   See Installation instructions for general information on required configuration and prerequisites, compilation procedure, setting environment principles.
2. How to configure a SALOME application
   See Salome Application Concept to define your own configuration of SALOME and run it on one or several computers. This is the recommended way of configuration.

Module maintainer

Module maintainers are in charge of the development and debug of the SALOME modules. Each SALOME module is stored in a CVS base. CVS bases are organised in separate branches for developments and debug. All official or development releases are identified by a CVS tag.

1. Source code structuration and Unit Tests
   See Source code structuration and Unit Tests for general information on code directories structure, unit tests associated to the different kind of classes, and how to run the unit tests.
2. Some development utilities
   See Salome Kernel resources for developer for information on basic utilities for C++ and Python development, like trace and debug, exceptions, singleton.

SALOME programming model

You will find in the next pages information about specific points of SALOME Kernel :

• Using salome.py module
• DSC : DSC documentation page.
• Salome_file : Salome_file documentation page.
• Documentation of the KERNEL python package : The package salome.kernel provides logging tools, high-level functions to handle items in Salome study, and other utilities.

SALOME KERNEL module Developer Documentation

To browse the SALOME KERNEL module Developer Documentation, follow the links below or use navigation menu at the top of the page:

• Namespaces - list of KERNEL namespaces and scripts.
• Data Structures - list of all data structures and classes with brief descriptions.
• Files - list of all files with brief descriptions.