\nAt the time of this writing, the page points to the guide for version 2023 R2.
\nThe API allows you to:<\/p>\n
- \n
- Programmatically read and modify SCADE models, test results, and generated artifacts.<\/li>\n
- Run SCADE jobs such as code generation or model testing.<\/li>\n<\/ul>\n
A local SCADE installation<\/h4>\n
To interact with SCADE, you need a local installation of the SCADE product.<\/a><\/p>\n
It comes with:<\/p>\n
- \n
- A distribution of Python. For instance, SCADE 2023 R2 embeds Python 3.10 64bit under
\/contrib\/Python310<\/code><\/li>\n- A Python implementation of the SCADE API library, under
\/SCADE\/APIs\/Python\/lib<\/code><\/li>\n- Binary executables that will be used to execute some functions of the API (e.g. code generation), under
\/SCADE\/bin<\/code><\/li>\n<\/ul>\nNote: you may use your own distribution of Python instead of the one provided with SCADE. Should you opt for this, please make sure you extend your
PYTHONPATH<\/code> environment variable with the above directories.<\/em><\/p><\/blockquote>\nA sample starter script<\/h4>\n
Let\u2019s get started with a basic script template that opens a SCADE project and sets it up for use through the API. It will allow you to verify that your IDE setup is correct and functional.<\/p>\n
First, we need to load the project itself, represented by a
.etp<\/code> file on disk.<\/p>\nWhen using your IDE of choice, you\u2019ll need some preamble code to explicitly load a project:
\n##
\n# identical to scade -script ...
\nimport scade_env
\nscade_env.load_project('path\/to\/my\/scade\/project.etp')
\n##
\n<\/code><\/p>\nNote: SCADE supports running Python scripts directly from its user interface (known as SCADE Studio) or from the command line:
\nscade.exe -script ... []<\/code>
\nIn both cases, the project is automatically loaded by the SCADE executable before the Python script starts. Therefore, there is no need to explicitly load a project and theload_project<\/code> call is simply ignored.<\/p>\n<\/blockquote>\n<\/em><\/p>\n
Next, we\u2019ll import some API modules:<\/p>\n
import scade.model.project.stdproject as project
\nfrom scade import output
\n<\/code><\/p>\n<\/p>\n
Note: SCADE comes with two project APIs:<\/p>\n
- \n
scade.model.project.natproject<\/code>: Pure Python API.<\/li>\nscade.model.project.stdproject<\/code>: SCADE Studio API.<\/li>\n<\/ul>\nThe documentation advises importing
scade.model.project<\/code> which resolves to one of the above APIs depending on the name of the executable running the script:vcs.exe<\/code> orstdtcl.exe<\/code> on one hand, any other executable likepython.exe<\/code> on the other hand.
\nIn our sample script however, importingstdproject<\/code> directly ensures that scripts behave the exact same way, whether they are launched from a SCADE environment or an external Python environment.\n<\/p>\n<\/em><\/p><\/blockquote>\n
Finally, we can add some basic statements to navigate the model and print some information:<\/p>\n
projects = project.get_roots()
\nfor p in projects:
\n assert isinstance(p, project.Project)
\n output(p.pathname + 'n')
\n<\/code><\/p>\nNote: The
assert<\/code> statement may help your IDE\u2019s IntelliSense \/ auto-completion realize thatp<\/code> is of typeProject<\/code>.<\/em><\/p><\/blockquote>\nHere is the final script, all put together:<\/p>\n
##
\n# identical to scade -script ...
\nimport scade_env
\nscade_env.load_project('path\/to\/my\/scade\/project.etp')
\n##
\n
\nimport scade.model.project.stdproject as project
\nfrom scade import output
\n
\nprojects = project.get_roots()
\nfor p in projects:
\n assert isinstance(p, project.Project)
\n output(p.pathname + 'n')
\n<\/code><\/p>\nSetting up your favorite IDE<\/h3>\n
Now that we have the basics, let\u2019s look at setting up your IDE. In this article, we\u2019ll look at three popular ones: Visual Studio Code (or VS Code), PyCharm and Visual Studio.<\/p>\n
Visual Studio Code<\/h4>\n
Visual Studio Code (code.visualstudio.com<\/a>) is a free open-source IDE. It is popular because of its customizability through numerous extensions.<\/p>\n
Installation<\/h5>\n
Install & launch the IDE, then install the Python extension:<\/p>\n
- \n
- Open the Extensions panel with Ctrl + Shift + X<\/li>\n
- Type ‘python’ in the search field<\/li>\n
- Click ‘install’ for extension ‘Python’<\/li>\n<\/ul>\n
\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-vscode-install.gif\")
\n Installing the Python extension<\/em>\n<\/p>\nProject creation & configuration<\/h5>\n
A VSCode project, or more precisely a workspace, is a directory. Simply drag and drop a directory containing the above test script onto the IDE window to initialize a Python project.
\nIn your project, create a folder called.vscode<\/code>.
\nInside folder.vscode<\/code>, create a file calledsettings.json<\/code> with the following content:<\/p>\n{
\n \/\/ Use Python interpreter embedded with SCADE
\n \"python.defaultInterpreterPath\": \"\/contrib\/Python310\/python.exe\",
\n \/\/ Enable Intellisense autocomplete
\n \"python.autoComplete.extraPaths\": [
\n \"\/SCADE\/bin\",
\n \"\/SCADE\/APIs\/Python\/lib\"
\n ],
\n \"python.analysis.extraPaths\": [
\n \"\/SCADE\/APIs\/Python\/lib\"
\n ]
\n}
\n<\/code><\/p>\nThis tells VSCode to use the Python interpreter embedded with SCADE and enables autocomplete for the SCADE API.
\nInside folder.vscode<\/code>, create a file calledlaunch.json<\/code> with the following content:<\/p>\n{
\n \"version\": \"0.2.0\",
\n \"configurations\": [
\n {
\n \"name\": \"Python: Current File\",
\n \"type\": \"python\",
\n \"request\": \"launch\",
\n \"program\": \"${file}\",
\n \"console\": \"integratedTerminal\",
\n \"justMyCode\": true,
\n \"env\": {\"PYTHONPATH\": \"\/SCADE\/APIs\/Python\/lib;\/SCADE\/bin\"},
\n }
\n ]
\n}
\n<\/code><\/p>\nThis ensures that the SCADE API library is used at runtime.
\nYour VSCode project structure should now look as follows:<\/p>\n\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-vscode-project-structure.png\")
\n VSCode project structure<\/em>\n<\/p>\nResults<\/h5>\n
You may run and\/or debug your Python script. The debug view allows you to peek into the variables and their structure:<\/p>\n
\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-vscode-debug.png\")
\n Debugging a SCADE Python script in VSCode<\/em>\n<\/p>\nPyCharm<\/h4>\n
PyCharm (jetbrains.com\/pycharm<\/a>) is another popular IDE, specific to Python.<\/p>\n
Project creation & configuration<\/h5>\n
Click “File” then “New Project\u2026” to open this dialog:<\/p>\n
\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-pycharm-new-project.png\")
\n New PyCharm project<\/em>\n<\/p>\nClick “Add Interpreter” to add the Python executable delivered with your installation of SCADE:<\/p>\n
\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-pycharm-add-interpreter.png\")
\n Adding a Python interpreter to PyCharm<\/em>\n<\/p>\nComplete project creation by clicking “OK”, then “Create”.
\nClick “File” then “Settings…” to open the settings window. Configure “Project Structure” as follows:<\/p>\n\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-pycharm-project-structure.png\")
\n PyCharm project structure to work with SCADE APIs<\/em>\n<\/p>\nUse button “+ Add Content Root” to add the following folders:<\/p>\n
- \n
SCADEAPIsPythonlib<\/code><\/li>\nSCADEbin<\/code><\/li>\n<\/ul>\nThis tells PyCharm to use the SCADE API sources for autocompletion services.<\/p>\n
Results<\/h5>\n
You may run and\/or debug your Python script. The debug view allows you to peek into the variables and their structure:<\/p>\n
\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-pycharm-debug.png\")
\n Debugging a SCADE Python script in PyCharm<\/em>\n<\/p>\nVisual Studio<\/h4>\n
Visual Studio (visualstudio.microsoft.com<\/a>) is a popular IDE for .NET and C++ development on Windows. It can support Python development thanks to extensions.<\/p>\n
Installation<\/h5>\n
Upon installation of Visual Studio, make sure to tick the Python Workload:<\/p>\n
\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-visual-studio-install-python-workload.png\")
\n Visual Studio installation with Python Workload<\/em>\n<\/p>\nProject creation & configuration<\/h5>\n
Click “File”, “New”, then “Project” to open the new project dialog. Select “From Existing Python code” then click “Next”:<\/p>\n
\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-visual-studio-new-project.png\")
\n Creating a new Python project in Visual Studio<\/em>\n<\/p>\nFill in your preferred project name and path, then finalize by clicking “Create”.
\nYour Solution Explorer should look like this:<\/p>\n\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-visual-studio-project-structure.png\")
\n Solution Explorer before project configuration<\/em>\n<\/p>\nBy default, the project uses one of your standard installed Python interpreters. We recommend using the Python environment installed with SCADE.
\nTo do so, right click “Python Environments”, then “View All Python Environments”. Click “Add Environment” and fill the pop-up as follows:<\/p>\n\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-visual-studio-add-python-environment.png\")
\n Adding the SCADE Python environment to Visual Studio (shown for SCADE 2024 R1)<\/em>\n<\/p>\nClick “Add” to apply your changes. The new Python environment should now be selected in your Solution Explorer view.
\nNext, right-click “Search Paths” and select “Add Folder to Search Path\u2026” twice to add the following folders:<\/p>\n- \n
SCADEAPIsPythonlib<\/code><\/li>\nSCADEbin<\/code><\/li>\n<\/ul>\nThis tells Visual Studio to use the SCADE API sources for autocompletion services.
\nMake sure to drop the sample Python script into your project folder.
\nYour Solution Explorer view should now look as follows:<\/p>\n\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-visual-studio-project-structure-2.png\")
\n Complete project structure<\/em>\n<\/p>\nResults<\/h5>\n
You may run and\/or debug your Python script. The debug view allows you to peek into the variables and their structure:<\/p>\n
\n
![](\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/scade-005-visual-studio-debug.png\")
\n Debugging a SCADE Python script in Visual Studio<\/em>\n<\/p>\nQuestions?<\/h5>\n
Once this small test script works in your IDE of choice, you are ready to go! Remember to refer to the API documentation over at developer.ansys.com\/scade<\/a> as you develop.
\nIf you have questions or feedback, don\u2019t hesitate to ask our Ansys expert community<\/a>.<\/p>\nAbout the author<\/h3>\n
\n
\n \n \n
![](\"https:\/\/innovationspace.ansys.com\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/09\/scade-jean-henry.png\")
\n <\/td>\n\n
- A Python implementation of the SCADE API library, under
- A distribution of Python. For instance, SCADE 2023 R2 embeds Python 3.10 64bit under