.. _l-functions:

Functions
=========

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


Summary
+++++++

+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| function                                                                 | class parent | truncated documentation                                                                                               |
+==========================================================================+==============+=======================================================================================================================+
| :func:`_setup_hook <check_python_install._setup_hook>`                   |              | if this function is added to the module, the help automation and unit tests call it first before anything goes on ... |
+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`check <check_python_install.check>`                               |              | Checks the library is working. It raises an exception. If you want to disable the logs:                               |
+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`check_cartopy <check_python_install.check_cartopy.check_cartopy>` |              | Runs a sample with :epkg:`cartopy`. Returns a graph.                                                                  |
+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`check_numba <check_python_install.check_numba.check_numba>`       |              | Runs a sample with :epkg:`numba`.                                                                                     |
+--------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+