.. genepy3d documentation master file, created by
   sphinx-quickstart on Wed Sep 18 15:44:48 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Reference documentation of the genepy3d packages
=================

You found the reference documentation of the genepy3d package, a python library for quantitative geometry.

Maybe your are looking for the main documentation, with install info, tutorial ect...? `Here <https://genepy3d.gitlab.io>`_

Mabybe you are looking for the code repositories? `Here <https://gitlab.com/genepy3d/>`_.

genepy3d
========

.. toctree::
   :maxdepth: 4

   genepy3d

Licences
========

GeNePy3d is part of the larger scipy ecosystem in python, and as such is released under the permissive BSD licence to facilitate its use; arguments for using BSD in scientific sotfware can be found for example `here <https://www.astrobetter.com/blog/2014/03/10/the-whys-and-hows-of-licensing-scientific-code/>`_.

But some software directly in the scope of GeNePy3D mission are released under the GPL licence, in particular CGAL. To still be able to use it we separated functions linking out to CGAL and other GPL software in a distinct repository installed with a different package, `genepy3d_gpl <https://genepy3d.gitlab.io/genepy3d_gpl>`_. The distinction is unimportant in practice for academic use and more generally if you do not plan to release software but needed to be made.


Funding
=======

This development was originaly supported by Agence Nationale de la Recherche (contract ANR-11-EQPX-0029 Morphoscope2)
   


.. Indices and tables
.. ==================

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`