Getting started#

To use Ansys SCADE ALM Gateway connector for sphinx-needs, you must have a valid license for Ansys SCADE.

For information on getting a licensed copy, see the Ansys SCADE Suite page on the Ansys website.

Requirements#

The ansys-scade-almgw-sphinx-needs package supports only the versions of Python delivered with Ansys SCADE, starting from 2021 R2:

  • 2021 R2 to 2023 R1: Python 3.7

  • 2023 R2 and later: Python 3.10

Install in user mode#

The following steps are for installing Ansys SCADE ALM Gateway connector for sphinx-needs in user mode. If you want to contribute to Ansys SCADE ALM Gateway connector for sphinx-needs, see Contribute for installing in developer mode.

  1. Before installing Ansys SCADE ALM Gateway connector for sphinx-needs in user mode, run this command to ensure that you have the latest version of pip:

    python -m pip install -U pip

  2. Install Ansys SCADE ALM Gateway connector for sphinx-needs with this command:

    python -m pip install --user ansys-scade-almgw-sphinx-needs

  3. For Ansys SCADE releases 2024 R1 and below, complete the installation with this command:

    python -m ansys.scade.almgw_sphinx_needs.register

    Note

    This additional step is not required when installing the package with Ansys SCADE Extension Manager.

  4. For Ansys SCADE 2024 R2 and below, complete the installation as follows:

    1. Copy ansys/scade/almgw_sphinx_needs/almgw_sphinx_needs.properties to the SCADE LifeCycle/ALM Gateway/external directory of the SCADE 2024 R2.

      For example: C:\Program Files\ANSYS Inc\v242\SCADE\SCADE LifeCycle\ALM Gateway\external.

    2. Edit the copy of almgw_sphinx_needs.properties to replace %PYTHON_DIR% by the Python’s directory selected for the package’s installation, to access ansys_scade_almgw_sphinx_needs.exe.