user_manual:installation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
user_manual:installation [2021/07/10 12:13]
Ali Baba [How to install SesamX]
user_manual:installation [2023/10/16 21:25] (current)
Ali Baba
Line 1: Line 1:
 +{{description>Learn how to install the SesamX suite.}}
 +
 +====== 1. Installation procedure ======
 +
 +Before using the SesamX suite, you first need to install the software. **This page aims at describing what is inside the installation package and how to install all its components**. 
 +
 +Currently, only the Windows (7/8/10) platform is supported. You should not worry about external dependencies, the package contains everything that is needed.
 +
 +Each new package has a version number attached to it. **The current version is the V2023_03**.
 +
 +Before proceeding, you need to download the installation package. You can find it on the [[https://www.sesamx.io/pricing/|SesamX download page]].
 +
 +===== The installation package =====
 +**The installation package is mainly composed of the SesamX software (the finite element solver) and the well known [[https://www.salome-platform.org/|Salome software]]**. This Salome version has been **customized to enable efficient post-processing for SesamX models**. These 2 software compose what we call the **SesamX suite**.
 +
 +Among these 2 main software, you also find in the installation package: 
 +  * the **SesamX Notepad++ user language** ("userDefineLang_sesamx.xml"), which provides syntax highlight for [[user_manual:sesamx:input_file|SesamX input files]]. 
 +  * a "batch" folder containing **ready to run SesamX input files**.
 +
 +For instance, the current version of the installation package contains the following files.
 +
 +{{ :user_manual:install_package_files.png?nolink&200 |}}
 +
 +Once the download is complete, you need to **unzip the archive and then proceed to the installation**.
 +
 +===== How to install SesamX =====
 +Inside the installation archive, you find the **"SesamX" folder**. **It contains the whole SesamX program** (and the "runSesamX.bat" script used to run SesamX input files). You can move this folder wherever you like on your computer. For consistence with this user manual, we assume that you move the SesamX folder to the root of the E drive. This is pretty much all you need to do to install SesamX.
 +
 +**To benefit from the SesamX input file syntax highlight, you need first to install [[https://notepad-plus-plus.org/|Notepad++]]**.
 +
 +Then, to install the SesamX user language, you need to run Notepad++ and click on Language / User Defined Language / Define your language.
 +
 +{{ :user_manual:install_n_user_language_1.png?nolink&500 |}}
 +
 +And then click on import, and select the "userDefineLang_sesamx.xml" file from the installation package.
 +
 +{{ :user_manual:install_n_user_language_2.png?nolink&500 |}}
 +
 +An "Import successful." box should appear, you can click on OK and restart Notepadd++. And finally you will be able to select the SesamX user language as shown below.
 +
 +{{ :user_manual:install_n_user_language_3.png?nolink&500 |}}
 +
 +<callout type="info" icon="true">As long as a text file carries the ".sx" extension, Notepad++ will automatically apply the SesamX user language. Otherwise, you have to select it manually from the Language menu.</callout>
 +
 +===== How to install Salome =====
 +To install Salome you need to **unzip the "SALOME-9.9.0.zip" archive**. To avoid issues, the Salome support team advises to unzip this folder near the root of your drive. And the full path to the directory should not contain any space nor special character. **For instance, you can unzip the Salome archive to "C:\SALOME-9.9.0"**.
 +
 +===== Conclusion =====
 +You are now ready to use Salome for pre and post-processing. To get you started you can refer to the following pages:
 +  * [[user_manual:pre_processing|Pre-processing a SesamX model]]
 +  * [[user_manual:post_processing|Post-processing a SesamX model]]
 +
 +If you prefer, you can also directly run the SesamX examples from the "batch" folder to get an idea of the SesamX capabilities. To get you started you can refer to the following page:
 +  * [[user_manual:sesamx|SesamX model manipulation]]
 +
 +<HTML>
 +If you encountered an issue during the installation procedure, do not hesitate to contact <a href="mailto:ali.baba.@mailbox.org" title="support" > our support </a>.
 +</HTML>
 +
 +----
 +
 +===== See also =====
 +  * [[user_manual:pre_processing|Pre-processing a SesamX model]]
 +  * [[user_manual:post_processing|Post-processing a SesamX model]]
 +  * [[user_manual:sesamx|SesamX model manipulation]]
 +  * [[user_manual:sesamx:input_file|SesamX input file]]
 +
 +===== References =====
 +  * [[https://www.sesamx.io/pricing/|SesamX suite download]]
 +  * [[https://www.salome-platform.org/|Salome platform website]]
 +  * [[https://notepad-plus-plus.org/|Notepad++ editor website]]