.. _getting_started:

===========
Get Started
===========

The following information is designed to get users up and running with
``predictably`` quickly. For more detailed information, see the links in each
of the subsections.

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

``predictably`` currently supports:

* environments with python version 3.7, 3.8, 3.9, 3.10 or 3.11
* operating systems Mac OS X, Unix-like OS, Windows 8.1 and higher
* installation via ``PyPi``

Users can choose whether to install the ``predictably`` with its standard dependencies
or alternatively to install ``predictably`` with all its dependencies using the
code snippets below.

.. tab-set::

    .. tab-item:: PyPi

        .. code-block:: bash

           pip install predictably

    .. tab-item:: PyPi (all dependencies)

        .. code-block:: bash

           pip install predictably[all_extras]

    .. tab-item:: Conda

        .. note::

            We are still working on creating releases of ``predictably`` on ``conda``.
            If you would like to help, please open a pull request.

    .. tab-item:: Conda (all dependencies)

        .. note::

            We are still working on creating releases of ``predictably`` on ``conda``.
            If you would like to help, please open a pull request.

For additional details see our :ref:`full installation guide <full_install>`.


Key Concepts
============

.. warning::

    The ``predictably`` package is new and this part of the documentation is still
    being developed as the package works toward maturity.



Quickstart
==========
The code snippets below are designed to introduce ``predictably``'s
functionality. For more detailed information see the :ref:`tutorials`,
:ref:`user_guide` and :ref:`api_ref` in ``predictably``'s
:ref:`user_documentation`.

.. _scikit-learn: https://scikit-learn.org/stable/index.html
.. _sktime: https://www.sktime.org/en/stable/index.html