ansys-scadeone-core 0.8.2

About

PyScadeOne is a Python library for the Ansys Scade One model-based development environment.

This library allows:

• Data access

  • Reading projects and navigating in models

  • Reading and editing simulation data files

  • Reading test results

  • Reading information about the generated code

• Ecosystem integration

  • Exporting FMI 2.0 components

Prerequisites

PyScadeOne requires .NET runtime 8.0.

Installation

Refer to the official installation guidelines.

Documentation

The documentation of PyScadeOne contains the following chapters:

• Getting started. This section provides a brief overview and instructions on how to get started with the project. It typically includes information on how to install the project, set up any necessary dependencies, and run a basic example or test to ensure everything is functioning correctly.

• User guide. The user guide section offers detailed documentation and instructions on how to use the project. It provides comprehensive explanations of the project’s features, functionalities, and configuration options. The user guide aims to help users understand the project’s concepts, best practices, and recommended workflows.

• API reference. The API reference section provides detailed documentation for the project’s application programming interface (API). It includes information about classes, functions, methods, and their parameters, return values, and usage examples. This reference helps developers understand the available API endpoints, their functionalities, and how to interact with them programmatically.

• Examples. The examples section showcases practical code examples that demonstrate how to use the project in real-world scenarios. It provides sample code snippets or complete scripts that illustrate different use cases or demonstrate specific features of the project. Examples serve as practical references for developers, helping them understand how to apply the project to their own applications.

Documentation contains UML diagrams generated by PlantUML.

License

The license of the PyScadeOne project is MIT. Read the full text of the license in the LICENSE file.