PyScadeOne documentation  |version|
===================================

PyScadeOne is a Python library for the
`Ansys Scade One <https://www.ansys.com/products/embedded-software/ansys-scade-one>`_:superscript:`TM`  
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

  - importing `SCADE Test <https://www.ansys.com/products/embedded-software/ansys-scade-test>`_ tests procedures
  - exporting `FMI 2.0 <https://fmi-standard.org/>`_ components

.. grid:: 3

   .. grid-item-card:: :fa:`terminal` Getting started
      :link: ref_getting_started
      :link-type: ref

      Learn how to install and run PyScadeOne.
      Check for supported versions.


   .. grid-item-card:: :fa:`book` User guide
      :link: ref_user_guide
      :link-type: ref

      Understand key PyScadeOne concepts for projects and models.

   .. grid-item-card:: :fa:`book-open-reader` Library reference
      :link: ref_api
      :link-type: ref

      Understand PyScadeOne library, its capabilities,
      and how to use it programmatically.


.. grid:: 2


   .. grid-item-card:: :fa:`gears` Examples
      :link: ref_examples
      :link-type: ref

      Explore examples that show how to use PyScadeOne. 


   .. grid-item-card:: :fa:`users` Contribute
      :link: ref_contributing
      :link-type: ref
  
      Learn how to contribute to the PyScadeOne codebase
      or documentation.


.. toctree::
   :hidden:
   :maxdepth: 3

   getting_started/index
   user_guide/index
   api/index
   examples/index
   contrib