<commit_before>
h1(#installation-guide). Installation Guide

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). Dependencies

h3(#eclipse). 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 contained 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). 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. e. either 32 or 64 bit, whichever is appropriate for your computer.

h2(#platform-overview). Platform overview

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

* "Installing YAKINDU Statechart Tools on Windows":#installing-on-windows
* "Installing YAKINDU Statechart Tools on Mac  OS X":#installing-on-macosx
* "Installing YAKINDU Statechart Tools on Linux":#installing-on-linux

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

* "Installing YAKINDU Statechart Tools to an existing Eclipse instance":#installing-to-an-existing-eclipse-instance

h2(#installing-on-windows). Installing on Windows

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

h3(#unpacking-the-downloaded-file). Unpacking the downloaded file
<commit_msg>Documentation: introduction of installation guide reworked, see issue #712. (#773)<commit_after>
h1(#installation-guide). Installation Guide

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.

The installation process boils down to
# checking the "system requirements":#system-requirements,
# unpacking the downloaded ZIP file containing YAKINDU Statechart Tools, and
# executing the _SCT_ application.

This is explained in more detail in section "&quot;Platform overview&quot;":#platform-overview and the following sections.

h2(#system-requirements). System requirements

h3(#java). Java

YAKINDU Statechart Tools is based on the Java programming language and requires *Java 7* or higher. A Java Runtime Environment (JRE) must be installed on your computer.

Installation of Java is beyond the scope of this document. You can find more information on Java and download it for free from Oracle Corporation at "https://www.java.com/":https://www.java.com/. Before downloading Java, 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.

h3(#eclipse). Eclipse

Internally, YAKINDU Statechart Tools are based on *"Eclipse":http://www.eclipse.org/*, an integrated development environment (IDE). YAKINDU Statechart Tools are running inside the Eclipse environment. When you are installing YAKINDU Statechart Tools, a full-fledged Eclipse instance will be put on your computer. Currently (summer 2016) it is the *Mars* release.

If you are new to Eclipse, you might find the "Eclipse Help":http://help.eclipse.org/ useful, especially the "Workbench User Guide".

If you are an experienced Eclipse user, you can install YAKINDU Statechart Tools into a existing Eclipse instance from an update site.

h2(#platform-overview). Platform overview

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

* "Installing YAKINDU Statechart Tools on Windows":#installing-on-windows
* "Installing YAKINDU Statechart Tools on Mac  OS X":#installing-on-macosx
* "Installing YAKINDU Statechart Tools on Linux":#installing-on-linux

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

* "Installing YAKINDU Statechart Tools to an existing Eclipse instance":#installing-to-an-existing-eclipse-instance

h2(#installing-on-windows). Installing on Windows

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

h3(#unpacking-the-downloaded-file). Unpacking the downloaded file

{'fraction_non_alphanumeric': 0.05805597579425113, 'fraction_numerical': 0.00661875945537065, 'mean_word_length': 4.962795941375423, 'pattern_counts': {'":': 14, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 5, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 13, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '21388', 'n_tokens_mistral': 1413, 'n_tokens_neox': 1326, 'n_words': 712}