Getting Started
Welcome to Sim4Sys! This quick-start guide will help you get up and running with the Sim4Sys toolchain in just a few steps.
What is Sim4Sys?
Sim4Sys is a comprehensive toolchain for agile systems engineering and model-driven system engineering (MBSE). It enables you to:
- Model systems using UML/SysML
- Generate C++ code from your models
- Visualize and validate system behaviors in a virtual environment
- Share your work with stakeholders early in the development process
The toolchain consists of two main tools:
- Sim4Sys-Designer - Desktop tool for UML/SysML modeling and code generation
- Sim4Sys-Virtual Bench - Web-based visualization environment
Quick Start Path
Step 1: Understand the Process
Before diving into the tools, familiarize yourself with the Sim4Sys approach:
- An agile process - Learn about the agile systems engineering methodology
- The detailed process - Understand the complete workflow
- The tooling - Get an overview of the tools
Step 2: Set Up Your Environment
Install Sim4Sys-Designer
- Download Sim4Sys-Designer - Get the latest version for your platform
- Install and Configure - Follow the installation guide
- For Windows users: Install Cygwin or MinGW for code compilation
- For Linux users: See Ubuntu/WSL installation
- For macOS users: See macOS installation
- Create a Hub4Sys account - Required for accessing Sim4Sys-Designer and Virtual Bench
Access Virtual Bench
- Log in to Virtual Bench - Access the web-based visualization environment at sim4sys.com
- Install the Launcher (optional) - For running executables locally
Step 3: Create Your First Model
Follow the modeling workflow:
- Create a Model - Start a new UML/SysML model
- Create a Project - Define your system project
- Create a Service - Add services to your project
- Create Sequence Diagrams - Model system behaviors
- Generate State Machine - Create state machines from your diagrams
- Generate Code - Generate C++ code from your model
For a comprehensive guide to the modeling process, see the Modeling Guide.
Step 4: Visualize Your Model
Connect your model to Virtual Bench for visualization:
- Export XML File - Export types and flows from Sim4Sys-Designer
- Create Executable in Virtual Bench - Add your executable to a Virtual Bench project
- Import Types and Flows - Import the XML file into Virtual Bench
- Create Mappings - Map model flows to visualization elements
- Run Visualization - Execute and observe your visualization
For Community version users, you'll need to compile your code on Hub4Sys before creating the executable.
Step 5: Learn Through Tutorials
Once you have the basics working, enhance your skills with tutorials:
- Tutorials Introduction - Start here for guided learning
- Tutorial 0: Quick Start - Create your first simple model
- Tutorial 1: Black Box Modeling - Learn service-level modeling
Common Workflows
Complete Development Cycle
1. Model → 2. Generate Code → 3. Compile → 4. Visualize → 5. Validate → 6. Iterate
- Model your system in Sim4Sys-Designer
- Generate C++ code from your model
- Compile the code (Pro version: locally | Community: on Hub4Sys)
- Visualize in Virtual Bench
- Validate system behavior
- Iterate and refine your model
Integration Workflow
Designer → Export XML → Virtual Bench → Import → Map → Run
Need Help?
Documentation Resources
- FAQ for Designer - Common issues and solutions
- Debugging in Virtual Bench - Troubleshoot visualization issues
- Debugging in Designer - Troubleshoot model issues
- Best Practices - Tips for efficient modeling
Getting Support
- Virtual Bench: Access help directly from the application interface
- Hub4Sys: Create issues and provide feedback through the built-in system
- Contact: Reach out via sim4sys-vr@cil4sys.com
Next Steps
Now that you're set up, explore:
- Detailed Process - Deep dive into the Sim4Sys methodology
- Communication Architecture - Understand system communication
- Advanced Features - Explore advanced Designer capabilities
- Virtual Bench Elements - Discover available visualization elements
Version Information
- Sim4Sys-Designer: Available in Community (free) and Pro versions
- Virtual Bench: Web-based SaaS application
- Latest Downloads: See Downloads page
- Updates: Check Updates page for version history
Ready to start? Begin with Step 1: Understand the Process or jump directly to Installation if you're ready to set up your environment.