.. _l-modules:

Modules
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| module                                             | truncated documentation                                                                                                                                                   |
+====================================================+===========================================================================================================================================================================+
| :ref:`__init__ <f-init>`                           | module ``actuariat_python``    Module *actuariat_python*.  It contains material for lectures,  lessons on programming, machine learning.      :githublink:`%|py|8`        |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                          | module ``actuariat_python.data``    shortcuts to data      :githublink:`%|py|5`                                                                                           |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzz>`                         |                                                                                                                                                                           |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzz>`                        |                                                                                                                                                                           |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzz>`                       | module ``actuariat_python.exams``    shortcuts to exams      :githublink:`%|py|5`                                                                                         |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzz>`                      | module ``actuariat_python.plots``    Shortcuts to plots      :githublink:`%|py|5`                                                                                         |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`data_exceptions <f-dataexceptions>`          | module ``actuariat_python.data.data_exceptions``    Exceptions raised by this module when getting data      :githublink:`%|py|5`                                          |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`elections <f-elections>`                     | module ``actuariat_python.data.elections``    Various function to download data about **French** elections.      :githublink:`%|py|6`                                     |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ex2016 <f-ex2016>`                           | module ``actuariat_python.exams.ex2016``    Dummy data for 2016      :githublink:`%|py|5`                                                                                 |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`faq_pandas <f-faqpandas>`                    | module ``actuariat_python.faq.faq_pandas``    Quelques questions d'ordre général autour du langage Python.        :githublink:`%|py|7`                                    |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`faq_python <f-faqpython>`                    | module ``actuariat_python.faq.faq_python``    Quelques questions d'ordre général autour du langage Python.        :githublink:`%|py|7`                                    |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`geocoding <f-geocoding>`                     | module ``actuariat_python.data.geocoding``    Various function to download data about **French** elections.      :githublink:`%|py|6`                                     |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`notebook_test_helper <f-notebooktesthelper>` | module ``actuariat_python.automation.notebook_test_helper``    Some automation helpers to test notebooks and check they are still working fine.      :githublink:`%|py|6` |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`population <f-population>`                   | module ``actuariat_python.data.population``    Various function to download data about population      :githublink:`%|py|6`                                               |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`pyramid <f-pyramid>`                         | module ``actuariat_python.plots.pyramid``    Graphs on population      :githublink:`%|py|5`                                                                               |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`wolf <f-wolf>`                               | module ``actuariat_python.data.wolf``    Various function to download data about population      :githublink:`%|py|6`                                                     |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    actuariat_python/__init__
    actuariat_python/automation/notebook_test_helper
    actuariat_python/data/__init__
    actuariat_python/data/data_elections/__init__
    actuariat_python/data/data_exceptions
    actuariat_python/data/data_population/__init__
    actuariat_python/data/elections
    actuariat_python/data/geocoding
    actuariat_python/data/population
    actuariat_python/data/wolf
    actuariat_python/exams/__init__
    actuariat_python/exams/ex2016
    actuariat_python/faq/faq_pandas
    actuariat_python/faq/faq_python
    actuariat_python/plots/__init__
    actuariat_python/plots/pyramid