Getting started

Installation

PyScadeOne is compatible with any Python version greater than Python 3.9. It has been tested with Python 3.9 and 3.12. It is distributed as a wheel package.

To install PyScadeOne use the command:

pip install ansys_scadeone-<version>-py3-none-any.whl

You may want to install PyScadeOne in a Python virtual environment. Please look at the Python venv module.

Requirements

PyScadeOne requires .NET Runtime 8 on your host. Please look at dotnet and at the installation scripts.

PyScadeOne uses the following .NET libraries:

• FsYaccFsLex, required for the Swan language parser

• FSharp, required for the Swan language parser

The required DLLs are delivered with PyScadeOne.

Supported versions

The versions for the supported format/code are:

• Graphical information format: 2.0

• Simulation data format: 1.1

• Swan language version: 2025.0

• Swan Test Harness: 1.1

• Test results format: 1.0

Quick start

Here is a small script showing how to load a Scade One project and get its model.

from ansys.scadeone.core import ScadeOne

my_project = "some_project.sproj"

with ScadeOne() as app:
    # load a project
    project = app.load_project(my_project)
    # explore project resources: dependencies, files, ...
    swan_model = project.model
    # do something nice with the swan model

More details can be found in Modeler section, and in API sections.