.. _overview:

************************
Premiers pas avec le SRD
************************

.. _installing-docdir:

Installation du SRD
======================

On peut installer facilement le SRD en utilisant pip::

  pip install srd

Le SRD dépend d'un autre package, `le SRPP <https://creei-models.github.io/srpp/>`_, qui permet de simuler les revenus de pensions publiques (RPC et RRQ) et les cotisations à ces régimes. Ce package est installé automatiquement en installant le SRD.

Dans un notebook ou un projet, on invoque le SRD en ajoutant la commande suivante:

.. code:: ipython3

    import srd

Pour désinstaller le SRD et le SRPP, il suffit d'utiliser pip::

  pip uninstall srd srpp

Installation alternative
------------------------

Si l'utilisation de pip n'est pas possible, un fichier .zip avec le SRD et sa dépendance, le SRPP, peut être téléchargé de `Github <https://github.com/CREEi-models/srd/releases>`_ (choisissez le fichier *srd_with_dep.zip* dans le dernier "release"). Pour utiliser le SRD, il suffit d'extraire les fichiers du .zip dans le répertoire de son choix et de travailler de ce dernier ou d'ajouter ce répertoire au chemin d'accès (par exemple en utilisant le module *sys*). Un tutoriel a également été inclus dans le fichier .zip. Si l'on ne veut plus le SRD, il suffit d'effacer les répertoires *srd* et *srpp*. 

Le SRD est fourni "tel quel", sous une `licence MIT <https://rsi-models.github.io/CPR/credits.html#licence>`_.

En cas de questions, commentaires ou suggestions, n'hésitez pas à nous contacter (:ref:`nous_contacter`).