//////////////////////////////////////////////////////////////////////////////
// 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
//////////////////////////////////////////////////////////////////////////////

include::_root_attributes.asciidoc[]

indexterm:[examples]

:leveloffset: -2

[[examples-chapter-index]]
== CIF examples

CIF ships with several examples and benchmark models.
To obtain these examples, follow these steps:

* Start the Eclipse ESCET IDE.
* Click menu:File[New > Example...].
* Select _CIF Examples_ or _CIF Benchmarks_ and click btn:[Next].
* Choose the name of the new project that will be created.
* Choose a location for the new project, on your hard disk.
If you leave the _Use default location_ option enabled, the new project will be created in workspace directory.
See the Eclipse ESCET documentation for more information on workspaces.
* Click btn:[Finish] to create the new project, and fill it with the examples.

For new releases of CIF, the examples may change.
The examples project that you previously created won't be automatically updated.
You can however go through the steps again, and get a second project, with the new examples.
The version of the release is included in the suggested project name, allowing multiple example projects for different releases.

Most examples also include a ToolDef <<tools-scripting-chapter-intro,script>> (`.tooldef` file) that can be used to perform various tasks, such as simulation.
To execute such a script, right click a `.tooldef` file an choose menu:Execute ToolDef[].
Alternatively, select the file and press kbd:[F10].

For the following examples, additional information is available:

* <<sbe-in-practice-example,Supervisory controller synthesis FIFO example>>
