//////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2010, 2026 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available
// under the terms of the MIT License which is available at
// https://opensource.org/licenses/MIT
//
// SPDX-License-Identifier: MIT
//////////////////////////////////////////////////////////////////////////////

// Including common attributes to set for all documents within this directory.
include::_root_attributes.asciidoc[]

// Enable inclusion of custom content from '*-docinfo*.html' files.
:docinfo: private

// Enable custom stylesheet.
:stylesheet: assets/asciidoctor-escet-project.css

// Use this for asciidoc documents containing a title.
:doctype: book

= Eclipse ESCET(TM) general toolkit documentation
:author: Copyright (c) 2010, 2026 Contributors to the Eclipse Foundation
:favicon: favicon.png

The Eclipse Supervisory Control Engineering Toolkit (Eclipse ESCET(TM)) project is an link:https://eclipse.org[Eclipse Foundation] open-source project that provides a toolkit for the development of supervisory controllers in the Model-Based Systems Engineering (MBSE) paradigm.
The toolkit has a strong focus on model-based design, supervisory controller synthesis, and industrial applicability, for example to cyber-physical systems.
The toolkit supports the entire development process of (supervisory) controllers, from modeling, supervisory controller synthesis, simulation-based validation and visualization, and formal verification, to real-time testing and implementation.

ifdef::website-output[]
TIP: You can link:eclipse-escet-project-manual.pdf[download this manual] as a PDF as well.
endif::website-output[]

'ESCET' is pronounced as 'èsèt'.
Or more precisely, it is pronounced as the following sequence of sounds: an 'e' of 'bed', an 's' of 'see', another 'e' of 'bed', and a 't' of 'tea'.
The emphasis is on the first part of the word.
In the link:https://en.wikipedia.org/wiki/International_Phonetic_Alphabet[International Phonetic Alphabet] it is spelled as ['ɛsɛt].

This documentation includes general information related to the Eclipse ESCET toolkit as a whole, as well as its general tools.
The following information is available:

* <<use-chapter-index>>
* <<performance-chapter-index>>
* Tools
** <<tools-chapter-dsm-clustering>>
* <<release-notes-chapter-index>>
* <<legal-chapter-index>>

The Eclipse ESCET toolkit features multiple languages and associated tools.
Check the website for each of these languages for more specific information, including separate documentation for each of them:

* link:https://eclipse.dev/escet/{escet-deploy-folder-name}/cif[CIF]
* link:https://eclipse.dev/escet/{escet-deploy-folder-name}/chi[Chi]
* link:https://eclipse.dev/escet/{escet-deploy-folder-name}/tooldef[ToolDef]

// Use

include::use/index.asciidoc[leveloffset=+2]

include::use/starting-first-time.asciidoc[leveloffset=+3]

include::use/update.asciidoc[leveloffset=+3]

include::use/remove.asciidoc[leveloffset=+3]

include::use/terminology.asciidoc[leveloffset=+3]

include::use/projects.asciidoc[leveloffset=+3]

include::use/edit-exec.asciidoc[leveloffset=+3]

include::use/escet-perspective.asciidoc[leveloffset=+3]

include::use/apps-view.asciidoc[leveloffset=+3]

// Performance

include::performance/index.asciidoc[leveloffset=+2]

include::performance/clear-console.asciidoc[leveloffset=+3]

include::performance/reduce-console-output.asciidoc[leveloffset=+3]

include::performance/close-running-apps.asciidoc[leveloffset=+3]

include::performance/tweak-perf-settings.asciidoc[leveloffset=+3]

// Tools

include::tools/dsm-clustering.asciidoc[leveloffset=+2]

// Release notes

include::release-notes.asciidoc[leveloffset=+2]

// Legal

include::documentation-legal.asciidoc[leveloffset=+2]

ifdef::pdf-output[]
[index]
== Index
endif::pdf-output[]
