.. _getting_started:

===============
Getting started
===============

.. toctree::
  :maxdepth: 2
  :caption: Getting Started
  :hidden:

  Installation <getting_started/install>
  User Guide <user_guide/user_guide>
  API Reference <reference/reference>

Installation
------------

^^^^^^^^
Easy way
^^^^^^^^

Install ``runpandas`` with:

.. code-block:: bash

  pip install runpandas

or with:

.. code-block:: bash

  conda install -c marcelcaraciolo runpandas

RunPandas depends on the following packages:

- ``pandas``
- ``fitparse``
- ``stravalib``
- ``haversine``
- ``pydantic``
- ``pyaml``
- ``thefuzz``

^^^^^^^^^^^^^^^^^^^^^
Detailed instructions
^^^^^^^^^^^^^^^^^^^^^

Do you prefer installation from source or specific version? See
:doc:`detailed instructions <getting_started/install>`.


What now
--------

- If you don’t have Runpandas yet, check :doc:`Installation <getting_started/install>`.

- If you have never used RunPandas and want to get familiar with it and its core functionality quickly, see our `Runpandas book <https://corriporai.github.io/runpandasbook/intro.html>`_.

- Detailed instructions about how to work with Runpandas, how to read files or perform activity analysis are part of our :doc:`User Guide <user_guide/user_guide>`.

- And if you are interested in the complete documentation of all classes, functions, method and attributes Runpandas offers, :doc:`API Reference <reference/reference>` is here for you.

.. container:: button

    :doc:`Installation <getting_started/install>`
    :doc:`User Guide <user_guide/user_guide>`
    :doc:`API Reference <reference/reference>`