.. _getting_started:

Overview
--------

CompSHS is an open source Python package for computational social sciences.

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

To install compshs, run this command in your terminal:

.. code-block:: console

    $ pip install compshs

Alternately, you can download the sources from `Gitlab`_ and run:

.. code-block:: console

    $ cd <compshs folder>
    $ python setup.py develop


.. _Gitlab: https://gitlab.telecom-paris.fr/compshs-team/compshs

Import
------

Import compshs in Python:

.. code-block:: python

    import compshs as cshs