goulib
======

library of useful Python code for scientific + technical applications.

see the `IPython notebook <https://github.com/goulu/goulib/blob/master/examples/notebook.ipynb>`_ for an overview of features

.. image:: https://badge.fury.io/gh/goulu%2Fgoulib.svg
    :target: https://badge.fury.io/gh/goulu%2Fgoulib
.. image:: http://img.shields.io/badge/license-LGPL-green.svg
    :target: https://github.com/goulu/goulib/blob/master/LICENSE.TXT
    :alt: License
.. image:: https://badge.fury.io/py/goulib.svg
    :target: https://pypi.python.org/pypi/goulib/
    :alt: Version
.. image:: https://github.com/goulu/Goulib/actions/workflows/build.yml/badge.svg
    :target: https://github.com/goulu/Goulib/actions/workflows/build.yml
    :alt: Build
.. image:: https://coveralls.io/repos/github/goulu/Goulib/badge.svg?branch=master
    :target: https://coveralls.io/github/goulu/Goulib?branch=master
    :alt: Coverage
.. image:: https://readthedocs.org/projects/goulib/badge/?version=latest
  :target: http://goulib.readthedocs.org/en/latest/
  :alt: Doc
  
:author: Philippe Guglielmetti goulib@goulu.net
:installation: "pip install goulib"
:distribution: https://pypi.python.org/pypi/goulib
:documentation: http://goulib.readthedocs.org/en/latest/
:examples: .. https://github.com/goulu/goulib/blob/master/examples/notebook.ipynb
:source: https://github.com/goulu/goulib

Requirements
------------

quite a lot of packages are needed for the full functionality of goulib, but most modules need only a small subset with lazy import when possible.

`Sphinx <http://sphinx-doc.org/>`_ is needed to generate this documentation,

Modules
-------

.. currentmodule:: goulib

.. autosummary::
    :toctree: modules

    colors
    containers
    datetime2
    decorators
    drawing
    expr
    geom
    geom3d
    graph
    image
    interval
    itertools2
    markup
    math2
    motion
    notebook
    optim
    periodic
    piecewise
    plot
    polynomial
    stats
    table
    tests
    units
    workdays
   
Classes
-------

.. inheritance-diagram::
    colors
    containers
    datetime2
    decorators
    drawing
    expr
    geom
    geom3d
    graph
    image
    interval
    itertools2
    math2
    motion
    notebook
    optim
    periodic
    piecewise
    plot
    polynomial
    stats
    table
    tests
    units
    workdays
    :parts: 2

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :doc:`changes`