{"id":197587,"date":"2025-11-05T11:09:08","date_gmt":"2025-11-05T11:09:08","guid":{"rendered":"https:\/\/innovationspace.ansys.com\/knowledge\/?post_type=topic&p=197587"},"modified":"2025-11-20T15:04:57","modified_gmt":"2025-11-20T15:04:57","slug":"pyscadeone-from-model-to-automation","status":"publish","type":"topic","link":"https:\/\/innovationspace.ansys.com\/knowledge\/forums\/topic\/pyscadeone-from-model-to-automation\/","title":{"rendered":"PyScadeOne – From Model to Automation"},"content":{"rendered":"

\n
\n <\/em>\n<\/p>\n

Introduction<\/h3>\n

At the heart of Ansys Scade One<\/strong> lies a model-based solution for developing embedded applicative software, enabling a seamless Model-Based Systems Engineering (MBSE) process. The main user interface is a graphical programming IDE, but under the hood, Scade One exposes a Python API<\/strong> called PyScadeOne<\/strong>, which we introduced in a previous article. It allows programmatic control over projects, jobs, simulations, code generation, and integration with external tools.<\/p>\n

In this article, we’ll show how PyScadeOne can be used to automate model verification, code generation, and FMU exports. These activities are foundational for automated CI\/CD actions, which we will cover in a follow-up article.<\/p>\n

PyScadeOne Architecture Overview<\/h3>\n

First, let’s look at what we’re working with. The PyScadeOne package follows a clear, layered design:<\/p>\n\n\n\n\n\n\n\n\n
\n

Layer<\/strong><\/p>\n<\/td>\n

\n

Purpose<\/strong><\/p>\n<\/td>\n

\n

Key Classes<\/strong><\/p>\n<\/td>\n<\/tr>\n

\n

API Core<\/strong><\/p>\n<\/td>\n

\n

Entry point, access to tools and projects<\/p>\n<\/td>\n

\n

ScadeOne<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

Project Management<\/strong><\/p>\n<\/td>\n

\n

Handles .sproj content, modules, resources, and dependencies<\/p>\n<\/td>\n

\n

Project<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

Model<\/strong><\/p>\n<\/td>\n

\n

Contains Swan module and interface declarations<\/p>\n<\/td>\n

\n

Model<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

Job Execution<\/strong><\/p>\n<\/td>\n

\n

Defines jobs (.sjob), properties, and execution<\/p>\n<\/td>\n

\n

Job, JobLauncher<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

Service Layer<\/strong><\/p>\n<\/td>\n

\n

Provides services such as FMU export, Python wrappers, and simulation data<\/p>\n<\/td>\n

\n

ansys.scadeone.core.svc.*<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

Interfaces<\/strong><\/p>\n<\/td>\n

\n

Decouples mutual dependencies between core classes<\/p>\n<\/td>\n

\n

IScadeOne, IProject<\/p>\n<\/td>\n<\/tr>\n<\/table>\n

\n
\n PyScadeOne overview (click to enlarge)<\/em>\n<\/p>\n

Launching jobs with PyScadeOne<\/h3>\n

The ScadeOne<\/code> object manages the lifecycle of all loaded projects and provides access to tool executables.<\/p>\n

<\/p>\n

\n
<\/span>from<\/span> ansys.scadeone.core.scadeone<\/span> import<\/span> ScadeOne\r\n\r\n# Initialize using the installation directory<\/span>\r\nsone =<\/span> ScadeOne(r"C:\\Program Files\\Ansys Inc\\vxxx\\Scade One"<\/span>)\r\n\r\n# Load an existing project<\/span>\r\nproject =<\/span> sone.<\/span>load_project("MySystem.sproj"<\/span>)\r\n\r\nproject.<\/span>load_jobs()\r\n\r\n# Inspect jobs<\/span>\r\nfor<\/span> job in<\/span> project.<\/span>jobs:\r\n\u00a0 \u00a0 print<\/span>(job.<\/span>name, job.<\/span>_kind)\r\n<\/pre>\n<\/div>\n
It exposes:<\/p>\n