path
====


This module is used to maniuplate and calculate geometry quantities on 3D paths.

*Note:* This module uses pyopencl (via ``simple_cl``) to compute any quantities
whose complexity is :math:`N^2`.
If your GPU has good float support, you may see a dramatic improvement in speed
by adding the following at the beginning of your code:

.. code-block:: python

    from ilpm import path
    path.set_opencl_params(device='gpu')


Overview
--------

.. currentmodule:: ilpm.path

.. autosummary:: 
    Path
    Tangle
    load_path
    load_tangle
    as_path
    set_opencl_params
    torus_knot
   
Classes and Functions
---------------------

.. automodule:: ilpm.path
    :members: 
    :show-inheritance: