Getting started with Specador
=============================

.. rst-class:: lead

    Specador runs on **Linux, Linux ARM, macOS ARM, and Windows**. There are two ways to set it up, depending on your preferred platform.

1. DVT Distribution
    The simplest way to get started is by downloading the **DVT (Design and Verification Tools)** distribution from the AMIQ `website <https://eda.amiq.com/download>`_. 
    This distribution comes with all the necessary components prepackaged.
    
    With this option, you can either run in :doc:`batch mode <how-to-run/specador.sh>` or from DVT IDE for :doc:`Eclipse <how-to-run/eclipse>` and :doc:`VS Code <how-to-run/vscode>`.

    .. note::

        For the **DVT IDE** integration, separate licenses are needed for both DVT IDE and Specador.

2. VS Code Marketplace
    Another option for getting started with Specador is by installing the **DVT IDE for VS Code** extension from the VS Code `Marketplace <https://marketplace.visualstudio.com/items?itemName=amiq.dvt>`_. 
    This extension allows you to run Specador directly within Visual Studio Code.

    After installing the extension, you will need to download the required Python runtime binaries. 
    These can either be automatically fetched from the internet or installed manually if the connection is not available.

    .. figure:: ../images/vscode-install-python.png
        :align: center
        
        VS Code notification if Python binaries are missing
    
    .. important::

        There are no prebuilt Python binaries for macOS x64, but they can be installed manually.

    To install the Python dependencies manually, you need the following:

    1. Python 3.10 or newer
    2. Install Specador Python :download:`requirements <py_requirements.txt>` using pip (Python package manager)
    3. Set the ``DVT_PYTHON_BIN`` environment variable to the path of your Python 3.10 binary, e.g. ``/usr/local/bin/python3.10``
    

.. rubric:: PDF Output Generation

Generating PDF documentation requires additional dependencies based on the running OS:

- Linux
    - `latexmk <https://www.cantab.net/users/johncollins/latexmk/>`_
    - texlive-luatex
    - texlive-formats-extra
    - texlive-fonts-extra
    - texlive-lang-japanese - *Optional (adds support for japanese characters)* 
- macOS
    - `MacTeX <https://www.tug.org/mactex/mainpage2024.html>`_
- Windows
    - `MikTex <https://miktex.org/>`_  :download:`requirements <markdown_dependencies.txt>`
    - `GTK for Windows <https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases>`_ *contains the Cairo library, used in diagram generation*