.. LFPykit documentation master file, created by
   sphinx-quickstart on Thu Aug 20 10:33:12 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to LFPykit's documentation!
===================================

.. toctree::
    :maxdepth: 20
    :caption: Contents:


.. include:: readme.md



Module :mod:`lfpykit`
=====================
.. automodule:: lfpykit
    :members:
    :show-inheritance:
    :undoc-members:


class :class:`CellGeometry`
===========================
.. autoclass:: lfpykit.CellGeometry
    :members:
    :show-inheritance:
    :undoc-members:

Module :mod:`lfpykit.models`
============================
.. automodule:: lfpykit.models


class :class:`LinearModel`
--------------------------
.. autoclass:: lfpykit.LinearModel
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`CurrentDipoleMoment`
----------------------------------
.. autoclass:: lfpykit.CurrentDipoleMoment
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`PointSourcePotential`
-----------------------------------
.. autoclass:: lfpykit.PointSourcePotential
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`LineSourcePotential`
----------------------------------
.. autoclass:: lfpykit.LineSourcePotential
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`RecExtElectrode`
------------------------------
.. autoclass:: lfpykit.RecExtElectrode
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`RecMEAElectrode`
------------------------------
.. autoclass:: lfpykit.RecMEAElectrode
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`OneSphereVolumeConductor`
---------------------------------------
.. autoclass:: lfpykit.OneSphereVolumeConductor
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`LaminarCurrentSourceDensity`
------------------------------------------
.. autoclass:: lfpykit.LaminarCurrentSourceDensity
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`VolumetricCurrentSourceDensity`
---------------------------------------------
.. autoclass:: lfpykit.VolumetricCurrentSourceDensity
    :members:
    :show-inheritance:
    :undoc-members:

Module :mod:`lfpykit.eegmegcalc`
================================
.. automodule:: lfpykit.eegmegcalc

class :class:`eegmegcalc.FourSphereVolumeConductor`
---------------------------------------------------
.. autoclass:: lfpykit.eegmegcalc.FourSphereVolumeConductor
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`eegmegcalc.InfiniteVolumeConductor`
-------------------------------------------------
.. autoclass:: lfpykit.eegmegcalc.InfiniteVolumeConductor
    :members:
    :show-inheritance:
    :undoc-members:


class :class:`eegmegcalc.InfiniteHomogeneousVolCondMEG`
-------------------------------------------------------
.. autoclass:: lfpykit.eegmegcalc.InfiniteHomogeneousVolCondMEG
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`eegmegcalc.SphericallySymmetricVolCondMEG`
--------------------------------------------------------
.. autoclass:: lfpykit.eegmegcalc.SphericallySymmetricVolCondMEG
    :members:
    :show-inheritance:
    :undoc-members:

class :class:`eegmegcalc.NYHeadModel`
-------------------------------------
.. autoclass:: lfpykit.eegmegcalc.NYHeadModel
    :members:
    :show-inheritance:
    :undoc-members:


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

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