Artifacts
#########

This topic assists you in downloading the different artifacts generated by the build
process. These artifacts include wheels, source tarballs, and documentation
files in various formats.

Required artifacts
==================

These artifacts include the minimum software required for installing PySTK.
Extra dependencies for visualization in IPython or performing data-analysis
are not included.

.. jinja:: artifacts

    .. list-table::
        :header-rows: 1
        :widths: 16, 42, 42

        * - :fas:`laptop` Platform
          - :fas:`cog` Wheels
          - :fas:`code` Source
        {% for platform in SUPPORTED_PLATFORMS %}
        * - :fab:`{{ platform }}` {{ platform | capitalize }}
          - `{{ wheels }} <_static/artifacts/{{ wheels }}>`_
          - `{{ source }} <_static/artifacts/{{ source }}>`_
        {% endfor %}

Extra artifacts
===============

These artifacts include additional dependencies required for using some
features, like gRPC connections, Jupyter widgets, and data-analysis.

All extra artifacts
-------------------

These extra artifacts include all the dependencies for using any additional
features:

.. jinja:: wheelhouse

    .. csv-table::
       :header-rows: 1
       :widths: 16, 28, 28, 28

       :fas:`laptop` Platform,
       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
       :fab:`python` Python {{ python }}
       {%- if not loop.last -%},{%- endif -%}
       {% endfor %}
       {% for platform in SUPPORTED_PLATFORMS -%}
       :fab:`{{ platform }}` {{ platform | capitalize }},
       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
       `Download wheelhouse <{{ wheelhouse[platform][python]["all"] }}/{{ wheelhouse[platform][python]["all"].name }}.zip>`__
       {%- if not loop.last -%},{%- endif -%}
       {% endfor %}
       {% endfor %}

Extensions
----------

These extra artifacts provide a set of high-level workflows for automating
common tasks with PySTK.

.. jinja:: wheelhouse

    .. csv-table::
       :header-rows: 1
       :widths: 16, 28, 28, 28

       :fas:`laptop` Platform,
       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
       :fab:`python` Python {{ python }}
       {%- if not loop.last -%},{%- endif -%}
       {% endfor %}
       {% for platform in SUPPORTED_PLATFORMS -%}
       :fab:`{{ platform }}` {{ platform | capitalize }},
       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
       `Download wheelhouse <{{ wheelhouse[platform][python]["extensions"] }}/{{ wheelhouse[platform][python]["extensions"].name }}.zip>`__
       {%- if not loop.last -%},{%- endif -%}
       {% endfor %}
       {% endfor %}

gRPC
----

These extra artifacts include all the dependencies for using gRPC connections.

.. jinja:: wheelhouse

    .. csv-table::
       :header-rows: 1
       :widths: 16, 28, 28, 28

       :fas:`laptop` Platform,
       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
       :fab:`python` Python {{ python }}
       {%- if not loop.last -%},{%- endif -%}
       {% endfor %}
       {% for platform in SUPPORTED_PLATFORMS -%}
       :fab:`{{ platform }}` {{ platform | capitalize }},
       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
       `Download wheelhouse <{{ wheelhouse[platform][python]["grpc"] }}/{{ wheelhouse[platform][python]["grpc"].name }}.zip>`__
       {%- if not loop.last -%},{%- endif -%}
       {% endfor %}
       {% endfor %}

Jupyter
-------

These extra artifacts include all the dependencies for using interactive
visualization widgets within IPython environments, such as Jupyter Lab.

.. jinja:: wheelhouse

    .. csv-table::
       :header-rows: 1
       :widths: 16, 28, 28, 28

       :fas:`laptop` Platform,
       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
       :fab:`python` Python {{ python }}
       {%- if not loop.last -%},{%- endif -%}
       {% endfor %}
       {% for platform in SUPPORTED_PLATFORMS -%}
       :fab:`{{ platform }}` {{ platform | capitalize }},
       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
       `Download wheelhouse <{{ wheelhouse[platform][python]["jupyter"] }}/{{ wheelhouse[platform][python]["jupyter"].name }}.zip>`__
       {%- if not loop.last -%},{%- endif -%}
       {% endfor %}
       {% endfor %}

Migration
---------

These extra artifacts include all the dependencies for migrating your existing
Python code to PySTK. See the :ref:`migration guide <Migrate to PySTK>`.

.. jinja:: wheelhouse

    .. csv-table::
       :header-rows: 1
       :widths: 16, 28, 28, 28

       :fas:`laptop` Platform,
       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
       :fab:`python` Python {{ python }}
       {%- if not loop.last -%},{%- endif -%}
       {% endfor %}
       {% for platform in SUPPORTED_PLATFORMS -%}
       :fab:`{{ platform }}` {{ platform | capitalize }},
       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
       `Download wheelhouse <{{ wheelhouse[platform][python]["migration"] }}/{{ wheelhouse[platform][python]["migration"].name }}.zip>`__
       {%- if not loop.last -%},{%- endif -%}
       {% endfor %}
       {% endfor %}