<commit_before>h1(#InstallingYAKINDUStatechartTools). Installing YAKINDU Statechart Tools

{toc}

In order to start working with YAKINDU Statechart Tools, you have to install the software on your computer. We are assuming you have downloaded the software package and stored it somewhere on your machine.

h2. Dependencies

h3. Eclipse

YAKINDU Statechart Tools is based on the Eclipse integrated development environment (IDE) and runs inside Eclipse. The installation process as described below will put a full-fledged Eclipse instance on your computer. It is comprised in the YAKINDU Statechart Tools distribution file you downloaded. You will have to unpack and execute Eclipse in order to work with YAKINDU Statechart Tools inside of it.


h3. Java

While YAKINDU Statechart Tools is based on Eclipse, the latter in turn is based on Java. In order to use Eclipse, you also need a more or less recent Java version on your machine. Depending on what you are going to do with YAKINDU Statechart Tools, you either need a Java Runtime Environment (JRE) or a Java Development Kit (JDK). Since a JDK always contains a JRE, it is a safe bet to install the former. However, unless you are going to do some Java development – i.&nbsp;e. create a state machine, turn it into Java source code, and use the latter from your Java client code –, you might get away with a JRE. Installation of Java is beyond the scope of this document. You can find more information and download the software from "https://www.java.com/":https://www.java.com/.

In case you don't have Java on your machine yet and you are going to download and install it, make sure you are picking the variant with the correct bit size, i.&nbsp;e. either 32 or 64 bit, whichever is appropriate for your computer.


h2. Plattform overview

You can either install YAKINDU Statechart Tools as a stand-alone software package under the following operating systems.

* "Installing YAKINDU Statechart Tools on Windows":#InstallingOnWindows
* "Installing YAKINDU Statechart Tools on MacOS":#InstallingOnMacOS
* "Installing YAKINDU Statechart Tools on Linux":#InstallingOnLinux

Alternatively you can install YAKINDU Statechart Tools to an existing Eclipse instance.

* "Installing YAKINDU Statechart Tools to an existing Eclipse instance":#InstallingOnEclipse



<div style="background: yellow">

h2(#InstallingOnWindows). Installing on Windows

This chapter describes how to install YAKINDU Statechart Tools on a Windows 7 machine.

h3. Unpacking the downloaded file

Unpack the software distribution file. Use the file explorer to open the directory you downloaded the software distribution file to, right-click on the latter, and select _Extract all_ in the context menu.

!=images/windows7_install_010_eclipse_extract_1.png!

Choose a directory for YAKINDU Statechart Tools (SCT). The example below assumes you want to install the software in the _C:\Program Files\yakindu_sct_ directory. Please modify as needed to install it somewhere else!

!=images/windows7_install_020_eclipse_extract_2.png!

After unpacking, you will find a folder _sct_ in your installation directory, i.&nbsp;e. _C:\Program Files\yakindu_sct\sct_ in our example, as shown in the image below:

!=images/windows7_install_030_eclipse_folder.png!

The contents of the _sct_ folder looks like this:

!=images/windows7_install_040_eclipse_contents.png!

There you are: You have installed YAKINDU Statechart Tools. Now you should start it.

h3. Starting YAKINDU Statechart Tools

Start YAKINDU Statechart Tools by running the _SCT.exe_ executable.

To do so, please double-click (or single-click, depending on your Windows settings) on the _YAKINDU_ symbol in the sample screenshot above.

While YAKINDU Statechart Tools is starting up, it is showing a splash screen:

!=images/windows7_install_050_eclipse_splash.png!

The software needs a _workspace_ directory where it stores its so-called projects along with other data. During the first startup, the _Workspace Launcher_ dialog asks you to specify the workspace directory in the _Workspace_ field. Please select a new and empty one.

In the example below, we chose the _C:\Users\joedoe\workspace_ directory as our workspace. We also checked the _"Use this as the default and do not ask again"_ option. This is sensible, because on subsequent startups, YAKINDU Statechart Tools won't ask for a workspace directory again. Instead it will always use the one we chose once and forever. (You can still change the workspace later via _File → Switch Workspace_ in the main menu.)

!=images/windows7_install_060_eclipse_workspace_dialog.png!

Click on the _OK_ button to proceed.

On the first start, YAKINDU Statechart Tools presents a _Welcome_ window:

!=images/windows7_install_070_eclipse_welcome.png!

You can browse the material shown here, if you want. When you are done, please close the _Welcome_ tab or click on _Workbench_ at the upper right. Both actions are leading to the workbench:

!=images/windows7_install_080_eclipse_workbench.png!

This is your working environment now. Congratulations, you have just installed YAKINDU Statechart Tools with Eclipse!

You can "proceed":../03_getting_started/getting_started.html now to create your first YAKINDU Statecharts Tools project.

</div>



<div style="background: yellow">

h2(#InstallingOnMacOS). Installing on MacOS

This chapter describes how to install YAKINDU Statechart Tools on a Mac under MacOS.

_*[To be done]*_

This is your working environment now. Congratulations, you have just installed YAKINDU Statechart Tools with Eclipse!

You can "proceed":../03_getting_started/getting_started.html now to create your first YAKINDU Statecharts Tools project.

</div>


h2(#InstallingOnLinux). Installing on Linux

This chapter describes how to install YAKINDU Statechart Tools on a Linux machine using a command-line tool. The installation doesn't require _root_ permissions.

h3. Unpacking the downloaded file

Choose a directory for YAKINDU Statechart Tools. The commands below assume you want to install the software in the _/my/software_ directory. Please modify the commands appropriately to install it somewhere else!

Go to the installation directory:

bc(prettyprint). 
cd /my/software/

Unpack the software distribution file. If the downloaded file is located in _/download/yakindu-sct-luna-R-linux-gtk-x86_64.tar.gz_, use the following command to unpack in the installation directory:

bc(prettyprint). 
gzip -dc /download/yakindu-sct-luna-R-linux-gtk-x86_64.tar.gz | tar xvfp -

This will create a folder _sct_ in your installation directory, i.&nbsp;e. _/my/software/sct_ in our example, as shown in the image below:

!=images/linux_install_010_eclipse_folder.png!

The contents of the _sct_ folder looks like this:

!=images/linux_install_020_eclipse_contents.png!

There you are: You have installed YAKINDU Statechart Tools. Now you should start it.


h3. Starting YAKINDU Statechart Tools

Start YAKINDU Statechart Tools by running the _SCT_ executable.

To do so, please enter the command

bc(prettyprint). 
sct/SCT

in your installation directory. Or issue the command

bc(prettyprint). 
/my/software/sct/SCT

if your command shell is in any other working directory.

From a file browser, you can start YAKINDU Statechart Tools by clicking on the _SCT_ symbol, shown as a gear-wheel in the sample screenshot above.

While YAKINDU Statechart Tools is starting up, it is showing a splash screen:

!=images/linux_install_030_eclipse_splash.png!

The software needs a _workspace_ directory where it stores its so-called projects along with other data. During the first startup, the _Workspace Launcher_ dialog asks you to specify the workspace directory in the _Workspace_ field. Please select a new and empty one.

In the example below, we chose the _/my/workspace_ directory as our workspace. We also checked the _"Use this as the default and do not ask again"_ option. This is sensible, because on subsequent startups, YAKINDU Statechart Tools won't ask for a workspace directory again. Instead it will always use the one we chose once and forever. (You can still change the workspace later via _File → Switch Workspace_ in the main menu.)

!=images/linux_install_040_eclipse_workspace_dialog.png!

Click on the _OK_ button to proceed.

<div style="background: yellow">

On the first start, YAKINDU Statechart Tools presents a _Welcome_ window:

!=images/linux_install_050_eclipse_welcome.png!

You can browse the material shown here, if you want. When you are done, please close the _Welcome_ tab or click on _Workbench_ at the upper right. Both actions are leading to the workbench:

!=images/linux_install_060_eclipse_workbench.png!

</div>

This is your working environment now. Congratulations, you have just started YAKINDU Statechart Tools!

You can "proceed":../03_getting_started/getting_started.html now to create your first YAKINDU Statecharts Tools project.



h2(#InstallingOnEclipse). Installing to an existing Eclipse instance

This chapter describes the steps that are needed to install YAKINDU Statechart Tools to an existing Eclipse instance. Let's assume you already have Eclipse up and running and now you want to install YAKINDU Statechart Tools as an additional software item (plugin).

In the the _Help_ menu, select the _Install new software_ menu item:

!images/eclipse_install_010_eclipse_menu_install_new_software.png!

The _Install_ wizard opens:

!images/eclipse_install_020_eclipse_install_wizard.png!<commit_msg>User documentation: some HTML issues fixed.<commit_after>h1(#InstallingYAKINDUStatechartTools). Installing YAKINDU Statechart Tools

{toc}

In order to start working with YAKINDU Statechart Tools, you have to install the software on your computer. We are assuming you have downloaded the software package and stored it somewhere on your machine.

h2. Dependencies

h3. Eclipse

YAKINDU Statechart Tools is based on the Eclipse integrated development environment (IDE) and runs inside Eclipse. The installation process as described below will put a full-fledged Eclipse instance on your computer. It is comprised in the YAKINDU Statechart Tools distribution file you downloaded. You will have to unpack and execute Eclipse in order to work with YAKINDU Statechart Tools inside of it.


h3. Java

While YAKINDU Statechart Tools is based on Eclipse, the latter in turn is based on Java. In order to use Eclipse, you also need a more or less recent Java version on your machine. Depending on what you are going to do with YAKINDU Statechart Tools, you either need a Java Runtime Environment (JRE) or a Java Development Kit (JDK). Since a JDK always contains a JRE, it is a safe bet to install the former. However, unless you are going to do some Java development – i.&nbsp;e. create a state machine, turn it into Java source code, and use the latter from your Java client code –, you might get away with a JRE. Installation of Java is beyond the scope of this document. You can find more information and download the software from "https://www.java.com/":https://www.java.com/.

In case you don't have Java on your machine yet and you are going to download and install it, make sure you are picking the variant with the correct bit size, i.&nbsp;e. either 32 or 64 bit, whichever is appropriate for your computer.


h2. Plattform overview

You can either install YAKINDU Statechart Tools as a stand-alone software package under the following operating systems.

* "Installing YAKINDU Statechart Tools on Windows":#InstallingOnWindows
* "Installing YAKINDU Statechart Tools on MacOS":#InstallingOnMacOS
* "Installing YAKINDU Statechart Tools on Linux":#InstallingOnLinux

Alternatively you can install YAKINDU Statechart Tools to an existing Eclipse instance.

* "Installing YAKINDU Statechart Tools to an existing Eclipse instance":#InstallingOnEclipse



h2(#InstallingOnWindows). Installing on Windows

This chapter describes how to install YAKINDU Statechart Tools on a Windows 7 machine.

h3. Unpacking the downloaded file

Unpack the software distribution file. Use the file explorer to open the directory you downloaded the software distribution file to, right-click on the latter, and select _Extract all_ in the context menu.

!images/windows7_install_010_eclipse_extract_1.png!

Choose a directory for YAKINDU Statechart Tools (SCT). The example below assumes you want to install the software in the _C:\Program Files\yakindu_sct_ directory. Please modify as needed to install it somewhere else!

!images/windows7_install_020_eclipse_extract_2.png!

After unpacking, you will find a folder _sct_ in your installation directory, i.&nbsp;e. _C:\Program Files\yakindu_sct\sct_ in our example, as shown in the image below:

!images/windows7_install_030_eclipse_folder.png!

The contents of the _sct_ folder looks like this:

!images/windows7_install_040_eclipse_contents.png!

There you are: You have installed YAKINDU Statechart Tools. Now you should start it.

h3. Starting YAKINDU Statechart Tools

Start YAKINDU Statechart Tools by running the _SCT.exe_ executable.

To do so, please double-click (or single-click, depending on your Windows settings) on the _YAKINDU_ symbol in the sample screenshot above.

While YAKINDU Statechart Tools is starting up, it is showing a splash screen:

!images/windows7_install_050_eclipse_splash.png!

The software needs a _workspace_ directory where it stores its so-called projects along with other data. During the first startup, the _Workspace Launcher_ dialog asks you to specify the workspace directory in the _Workspace_ field. Please select a new and empty one.

In the example below, we chose the _C:\Users\joedoe\workspace_ directory as our workspace. We also checked the _"Use this as the default and do not ask again"_ option. This is sensible, because on subsequent startups, YAKINDU Statechart Tools won't ask for a workspace directory again. Instead it will always use the one we chose once and forever. (You can still change the workspace later via _File → Switch Workspace_ in the main menu.)

!images/windows7_install_060_eclipse_workspace_dialog.png!

Click on the _OK_ button to proceed.

On the first start, YAKINDU Statechart Tools presents a _Welcome_ window:

!images/windows7_install_070_eclipse_welcome.png!

You can browse the material shown here, if you want. When you are done, please close the _Welcome_ tab or click on _Workbench_ at the upper right. Both actions are leading to the workbench:

!images/windows7_install_080_eclipse_workbench.png!

This is your working environment now. Congratulations, you have just installed YAKINDU Statechart Tools with Eclipse!

You can "proceed":../03_getting_started/getting_started.html now to create your first YAKINDU Statecharts Tools project.



h2(#InstallingOnMacOS). Installing on MacOS

This chapter describes how to install YAKINDU Statechart Tools on a Mac under MacOS.

_*[To be done]*_

This is your working environment now. Congratulations, you have just installed YAKINDU Statechart Tools with Eclipse!

You can "proceed":../03_getting_started/getting_started.html now to create your first YAKINDU Statecharts Tools project.



h2(#InstallingOnLinux). Installing on Linux

This chapter describes how to install YAKINDU Statechart Tools on a Linux machine using a command-line tool. The installation doesn't require _root_ permissions.

h3. Unpacking the downloaded file

Choose a directory for YAKINDU Statechart Tools. The commands below assume you want to install the software in the _/my/software_ directory. Please modify the commands appropriately to install it somewhere else!

Go to the installation directory:

bc(prettyprint). 
cd /my/software/

Unpack the software distribution file. If the downloaded file is located in _/download/yakindu-sct-luna-R-linux-gtk-x86_64.tar.gz_, use the following command to unpack in the installation directory:

bc(prettyprint). 
gzip -dc /download/yakindu-sct-luna-R-linux-gtk-x86_64.tar.gz | tar xvfp -

This will create a folder _sct_ in your installation directory, i.&nbsp;e. _/my/software/sct_ in our example, as shown in the image below:

!images/linux_install_010_eclipse_folder.png!

The contents of the _sct_ folder looks like this:

!images/linux_install_020_eclipse_contents.png!

There you are: You have installed YAKINDU Statechart Tools. Now you should start it.


h3. Starting YAKINDU Statechart Tools

Start YAKINDU Statechart Tools by running the _SCT_ executable.

To do so, please enter the command

bc(prettyprint). 
sct/SCT

in your installation directory. Or issue the command

bc(prettyprint). 
/my/software/sct/SCT

if your command shell is in any other working directory.

From a file browser, you can start YAKINDU Statechart Tools by clicking on the _SCT_ symbol, shown as a gear-wheel in the sample screenshot above.

While YAKINDU Statechart Tools is starting up, it is showing a splash screen:

!images/linux_install_030_eclipse_splash.png!

The software needs a _workspace_ directory where it stores its so-called projects along with other data. During the first startup, the _Workspace Launcher_ dialog asks you to specify the workspace directory in the _Workspace_ field. Please select a new and empty one.

In the example below, we chose the _/my/workspace_ directory as our workspace. We also checked the _"Use this as the default and do not ask again"_ option. This is sensible, because on subsequent startups, YAKINDU Statechart Tools won't ask for a workspace directory again. Instead it will always use the one we chose once and forever. (You can still change the workspace later via _File → Switch Workspace_ in the main menu.)

!images/linux_install_040_eclipse_workspace_dialog.png!

Click on the _OK_ button to proceed.

<div style="background: yellow">

On the first start, YAKINDU Statechart Tools presents a _Welcome_ window:

!images/linux_install_050_eclipse_welcome.png!

You can browse the material shown here, if you want. When you are done, please close the _Welcome_ tab or click on _Workbench_ at the upper right. Both actions are leading to the workbench:

!images/linux_install_060_eclipse_workbench.png!

</div>

This is your working environment now. Congratulations, you have just started YAKINDU Statechart Tools!

You can "proceed":../03_getting_started/getting_started.html now to create your first YAKINDU Statecharts Tools project.



h2(#InstallingOnEclipse). Installing to an existing Eclipse instance

This chapter describes the steps that are needed to install YAKINDU Statechart Tools to an existing Eclipse instance. Let's assume you already have Eclipse up and running and now you want to install YAKINDU Statechart Tools as an additional software item (plugin).

In the the _Help_ menu, select the _Install new software_ menu item:

!images/eclipse_install_010_eclipse_menu_install_new_software.png!

The _Install_ wizard opens:

!images/eclipse_install_020_eclipse_install_wizard.png!
{'fraction_non_alphanumeric': 0.04598551720492627, 'fraction_numerical': 0.009514244938950261, 'mean_word_length': 4.934755332496863, 'pattern_counts': {'":': 16, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 4, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 22, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4046889', 'n_tokens_mistral': 5344, 'n_tokens_neox': 5040, 'n_words': 2558}