2. The Python source organization#

2.1. Conventions#

The following conventions, which are intended to facilitate the reading of scripts, are imperfectly applied

  1. a class name starts with a capital letter;

  2. the identifier of a Python list object starts with the prefix l_ (this rule is used in Eficas);

  3. in the packages used by the supervisor (Kernel, Execution, Execution, Validation, Validation, Build and Accas) only one class is defined per module, i.e. per file*.py;

  4. in the packages used by the supervisor (Kernel, Execution, Execution, Validation, Validation, Build, and Accas) the name of each module starts with a prefix indicating the name of the package.

  1. N_ for Core

  2. V_ for Validation

  3. E_ for Execution

  4. B_ for Build

  5. A_ for Accas

2.2. Python module typology#

Each class is defined in a module: for example, class MCSIMP is defined in the N_ MCSIMP .py module where the N_ prefix designates the name of the package (Kernel) containing the module.

The package technique makes it possible to divide the modules according to the field of activity in which it acts. Each domain corresponds to a Python package

For example, class MCSIMP exists in each of the five packages,

  1. ·Core: N_ MCIMP. SIMP;

  2. ·Validation: V_ MCSIMP. SIMP;

  3. ·Hmm: I_ MCIMP. SIMP;

  4. ·Battery: A_ MCIMP. SIMP;

  5. ·Build: B_ MCIMP. SIMP;

Nucleus

This package essentially contains the command set factory class system.

Validation

This package contains modules that perform object validity checks (commands, conditional blocks, keywords,…).

Build

This package is only present in the supervisor contains the modules dealing with macro commands and methods for requesting the command set from API -C: the GETVxxx interfaces.

Accas

This package is the most important. In particular, it contains the most comprehensive classes used by the Eficas graphical interface as well as by the Code_Aster supervisor. It is in this package that you should look for objects and methods specialized in the processing — not graphical — of orders:

  1. loading the catalog;

  2. loading a command set;

  3. Executing the command set.

The daughter classes defined in this package are defined by inheritance from parent classes that have the same name as the daughter classes but are located in a different package.

IHM

The classes in this package enrich the Core classes with methods — not linked to the graphical aspect — used by the Eficas graphical interface.

Editor

This package contains the graphics processing modules for the command set.

2.3. Hierarchy of source directories#

2.3.1. Supervisor python sources#

The Code_Aster supervisor is composed of python modules written:

  1. in C for the supervisor application interface: the aster module (astermodule.c);

  2. in Python for the management of the command set (loading, organization,…).

The diagram below shows the directories containing the supervisor’s Python sources.

_images/Shape1.gif

2.3.2. The sources of the Eficas graphical interface#

The sources are organized in directories under the Eficas installation directory:

_images/Shape2.gif

2.4. The environment#

This paragraph describes the prerequisites for the operation of the Supervisor and the Eficas graphical interface.

2.4.1. Python interpreter installation#

To be informed

2.4.2. Shell configuration settings#

To be informed

2.4.3. Installing the Eficas graphical interface#

To be informed

2.4.4. Supervisor Update#

To be informed