Getting started

1.    Preliminaries

AltaRica 3.0 is the new version of the modeling language AltaRica dedicated to risk analysis (safety, reliability, performance) of complex systems.
The OpenAltaRica platform provides several tools to perform such analyses. This platform is protected by French laws and provided under a specific license. For any information or problem, see the OpenAltaRica forum or contact us. Finally if ever, report a bug.
This page summarizes process to install and configure the OpenAltaRica platform. According to the evolution of the platform, it will change (a lot). You can find the overall process in the Getting Started Document into the Docs & Downloads page.

2.    Installation

The OpenAltaRica platform is available for both Windows and Linux operating systems (32 bits and 64 bits). The version for Mac OS operating system is not yet available. The OpenAltaRica platform combines different technologies and requires some external elements to be used (e.g. a JVM).

1.    Download and install the OpenAltaRica platform

  • Go to the Docs & Downloads page;
  • Download the suited package depending on your operating system and its architecture (32 bits or 64 bits). The download will be delivered as a compressed file (i.e. a “.zip”, or “.tar.gz”);
  • Extract the downloaded compressed file into the directory of your choice (e.g. “C:\Applications\OpenAltaRica” on Windows or “/home/MyUser/App/OpenAltaRica” on Linux);

WARNING: ensure you have full “Read” and “Execute” permissions on this directory and the absolute file system path to this directory (also including this directory) does not include spaces and parenthesis;

2.    Install external tools

For external tools (jvm, XFTA, etc.) see the Getting Started Document into the Docs & Downloads page.

WARNING: ensure you have the appropriate version of the jvm (see the README file into the platform);

3.    Configurations

Go to the directory of your OpenAltaRica platform (e.g. “OpenAltaRicaPlatform”).

1.    Configure the AltaRica 3.0 Text Editor

Go to the directory “AR3Workshop/AR3TextEditor”. Optionally you can create a shortcut of the AltaRica 3.0 Text Editor launcher (the executable file “AR3TextEditor.exe” on Windows or “AR3TextEditor” on Linux).

1.    Configure the JVM

See the Getting Started Document into the Docs & Downloads page.

2.    Configure the workspace

The AltaRica 3.0 Text Editor is based on Eclipse and uses its main features. A workspace is the place (a directory) where the AltaRica 3.0 Text Editor will place all your projects. By default this workspace (the directory named “workspace”) is placed into the directory containing the AltaRica 3.0 Text Editor launcher. You can let it into this folder or move it (cut and paste) into every directory you want. If you want to move it, see the Getting Started Document into the Docs & Downloads page.

 

Launch the AltaRica 3.0 Text Editor (the file “AR3TextEditor.exe” on Windows or the file “AR3TextEditor” on Linux). After a few seconds the Workspace Launcher window opens.

  • If you have not moved the workspace, just click on the button “OK”.
  • Otherwise, click on the button “Browse”, select where you have moved your workspace (check the correct path appears into the line Workspace) and click on the button “OK”.

After a few seconds the AltaRica 3.0 Text Editor opens.

3.1-ConfigureAR3TextEditor-2

An existing project can be seen into the Project Explorer. It is named “Demo” and contains several sub-folders.

2.    Use the AltaRica 3.0 Text Editor

1.    Define a new project

  • Click on “File”, select “New” and “Project”;
  • Select “AltaRica Project” into the “AltaRica” folder and click on “Next”;
  • Enter the name of your new project (e.g. “MyNewProject”) and click on “Finish”;
  • The “Project Explorer” part of the AltaRica 3.0 Text Editor contains the new project (e.g. “MyNewProject”). By default, it contains several sub-directories:
    • “ARModels” where you design your AltaRica 3.0 models;
    • “FaultTrees” where fault trees will be generated and assessed;
    • “GTSModels” for every results coming from assessment tools;
    • “Scripts” where script simulation will be performed.

2.    Define a new AltaRica 3.0 model

  • Right-Click on the folder “ARModels”, select “New” and “Other…”;
  • A window opens. Select “AltaRica Model” into the “AltaRica” folder and click on “Next”;
  • Enter the name of your new model (e.g. “MyNewAR3Model.alt”) into the “File name” and click on “Finish”;
  • Click on “Yes” if the AltaRica 3.0 Text Editor asks you to add the Xtext nature to your project;
  • Your new AltaRica 3.0 model is now define into your project: a new file was created into the folder “ARModels”.

You can now edit your AltaRica 3.0 model.

3.    Compile an AltaRica 3.0 model

In order to be assessed, an AltaRica 3.0 model must be compiled (more precisely flattened). Click on your model you want to assess (into the Project Explorer part, or open it into the edition part), click on the “Run Menu” and choose “Compile AltaRica 3.0 model”.

 

The AltaRica 3.0 compiler is launched and if no error occurs, a new file named as your model with the extension “.xml” is created into the folder “GTSModels”.

4.    Perform a stepwise simulation with a model

First compile your AltaRica 3.0 model and then click on the “Run Menu” and choose “Stepwise Simulator”.

The Stepwise Simulator is launched and if no error occurs, you can perform the simulation into the Console part of the AltaRica 3.0 Text Editor. To perform simulation on your model, you have to write specific commands. They are explained by writing “help”.

5. Perform a script simulation with a model

In order to perform a script simulation, please follow these steps:

  • Compile your AltaRica 3.0 model;
  • Add a script file for the script simulation. A sample of such a file named “Sequence.test” can be found into the directory “Scripts” of the project “Demo” (do not rename it);
  • Edit this script file according what you want to simulate (see the previous part to find the commands of the stepwise simulator);
  • Then click on the “Run Menu” and choose “Script Simulator” (You must have selected your AltaRica 3.0 model).

The Script Simulator is launched and if no error occurs, you can see the results into the Console part of the AltaRica 3.0 Text Editor

6.    Generate a fault tree from an AltaRica 3.0 model

First compile your AltaRica 3.0 model and then click on the “Run Menu” and choose “Generate Fault Tree”.

The Fault Tree compiler is launched and if no error occurs a new file named as your model with the extension “.opsa” is created into the folder “FaultTrees”.

7.    Assess a fault tree

The OpenAltaRica platform is configured to assess fault trees with XFTA (this option is not yet available for Linux 32 bits).
In order to assess a fault tree with XFTA, please follow these steps:

  • Generate a fault tree from your AltaRica 3.0 model;
  • Add a script file for XFTA. A sample of such a file named ‘XFTA.xml’ can be found into the directory ‘Fault Trees’ of the project ‘Demo’ (you can rename it);
  • Edit this script file according to what you want to study into your fault tree (see the XFTA user manual to define properties into this script file);
  • Then click on the “Run Menu” and choose “Analyze Fault Tree (XFTA)” (You must have selected this script file).

More information into the Docs & Downloads page