Creating Your First SysML v2 Project

Welcome to your first hands-on experience with the AI SysML v2 Editor. This tutorial will guide you through the process of setting up a new modeling project, creating your first file, and defining a simple system. By the end of this guide, you will understand the fundamental workflow of this stable SysML v2 tool.

Prerequisites

Because our platform is a web-based SysML v2 editor, there is no software to install. You only need a modern web browser and an active internet connection to begin. This zero-install approach ensures you can start MBSE (Model-Based Systems Engineering) immediately on any operating system.

Step 1: Launch the Editor and Sign In

1. Navigate to the SysML v2 editor URL in your browser.
2. Sign in to your account. This ensures that your work is saved securely in the cloud-native workspace and synchronized across your devices.
3. Observe the default workspace. You should see the Navigator on the left and the Code Editor in the center.

Step 2: Organize Your Workspace with Folders

Good organization is key to a successful SysML software project. We will start by creating a dedicated folder for your first model.

1. Locate the Navigator (Cloud Explorer) pane on the left side of the screen.
2. Click the New Folder icon at the top of the Navigator.
3. Type a name for your folder, such as MyFirstSystem, and press Enter.
4. Your new folder will appear in the tree hierarchy, ready to hold your modeling assets.

Step 3: Create Your First SysML v2 File

Now that you have a folder, it’s time to create the actual .sysml document where you will write your system definitions.

1. Right-click on the MyFirstSystem folder you just created.
2. Select New File from the context menu.
3. Name the file Basics.sysml and press Enter.
4. The file will open automatically in the Tabbed Editor. You are now ready to start modeling in a professional SysML editor environment.

Step 4: Author Your First Block Definition

We will write a simple “Spacecraft” definition to test the stable syntax highlighting of the tool. Type the following code directly into the editor:

package 'First Project' {
    part def Spacecraft {
        attribute mass : ScalarValues::Real;
        part engine : Engine;
    }
    
    part def Engine;
}
    

As you type, observe the following features of the AI SysML tool:

• Syntax Coloration: Notice how keywords like package, part def, and attribute are highlighted in different colors. This is the precise syntax highlighting that ensures your model is easy to read.
• Auto-completion: Try typing Scal and see how the editor suggests ScalarValues. This is the LSP-powered IntelliSense at work.
• Real-time Validation: If you intentionally mistype a word, a red squiggle will appear. This immediate feedback makes this a highly stable SysML v2 tool for beginners.

Step 5: View the Auto-Generated Diagram

One of the most powerful aspects of this SysML v2 software is that you don’t need to draw diagrams manually.

1. Look at the Diagram Viewer pane (usually to the right of your code).
2. If your code is correct, you will see a visual block diagram showing the Spacecraft part definition and its relationship to the Engine.
3. Use your mouse wheel to Zoom and click-drag to Pan the view.

Step 6: Save and Verify

1. The SysML v2 editor typically saves your work automatically to the cloud.
2. Look for the “Saved” indicator in the status bar or the tab header to confirm your progress is secure.

Summary and Next Steps

Congratulations! You have successfully created your first SysML v2 project using a modern, web-based AI SysML tool. You have learned how to organize folders, create files, and write basic system definitions that render into live diagrams.

In the next tutorial, “Defining System Structure with Parts and Ports,” we will dive deeper into the internal composition of systems and how to model connections between components.