.. _how_to_install_atr_tools-label:

============
Installation
============

.. important:: We assume basic knowledge of Python. We recommend the 'Python Fundamental', 'Python for starters in
    practice' and 'Advanced Python' courses of the
    `Haskoning Digital Academy on WeConnect. <https://royalhaskoningdhv.csod.com/samldefault.aspx?ouid=-199&returnurl=/catalog/CustomPage.aspx?id=20000590>`__

.. important:: As a staff member of Haskoning you have access to the Haskoning python feed, which you need to install
    the official releases of the haskoning-atr-tools in projects. We advise to use official releases in projects because
    of versioning. You can request access to the repository if you want to develop the code-base, please contact
    `Jurriaan Floor <mailto:jurriaan.floor@haskoning.com>`__ or
    `Reinier Ringers <mailto:reinier.ringers@haskoning.com>`__.

.. note:: The haskoning-atr-tools requires minimum Python version 3.11.

Python
======
For the installation the same workflow is used as for haskoning-structural (the structural design client for DataFusr).
The workflow for haskoning_structural installation is described on this page:
`DataFusr FEM-client <https://datafusrfem.azurewebsites.net/getting_started/installation.html#>`_.

The installation script for the atr_tools can be downloaded with this link:

:download:`Installation script<downloads/install_atr_tools.bat>`

The update script for the atr_tools can be downloaded with this link:

:download:`Update script<downloads/update_atr_tools.bat>`

For manual installation this command can be used (please first check all the considerations of the haskoning_structural
documentation):

>>> pip install haskoning_atr_tools --extra-index-url="https://corporateroot.pkgs.visualstudio.com/_packaging/haskoning-py/pypi/simple/"

Equation
========
The functionality in the ATR-tools is available in the equations platform. The tools can be used in parametric workflows
in Grasshopper (Rhino 8.3).

We will be extending this section.

SD API
======
The functionality in the ATR-tools is available in the API for structural design. These can be used in custom scripts
or applications connecting to our structural design API.

We will be extending this section.