
.. _intro:

Introduction
===================================

The :py:mod:`envtoolkit` module is to be seen as a Python toolbox devoted to Earth Scientists. It is divided into multiple sub-modules, which are summarised in the table below.

+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|Module name                          | Contents                                                                                                           |
+=====================================+====================================================================================================================+
|:py:mod:`envtoolkit.map`             | Functions and classes related to maps (finding points within a polygon, masked Lambert projection)                 |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|:py:mod:`envtoolkit.colors`          | Functions and classes related to colors (generation of fancy colormaps, classification mapping)                    |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|:py:mod:`envtoolkit.ts`              | Functions and classes related to time-series processing (monthly and daily climatologies, Lanczos filtering,       |
|                                     | multitaper spectral analysis)                                                                                      |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|:py:mod:`envtoolkit.nc`              | Functions related to the handling of NetCDF files                                                                  |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+

This module is likely to evolve. Don't hesitate to regularly update to the last version (see the :ref:`install-down` section). 

If you have any questions, suggestions or if have found any bugs, feel free to contact me at `<barrier@otmed.fr>`_
