Welcome to LFPy’s documentation!

A brief video tutorial on LFPy is available here:

---

You can test LFPy online without installation, by clicking this button:

Note that you might need to be logged into an EBRAINS account for the link to work. To get a free EBRAINS account, sign up here: https://www.ebrains.eu/page/sign-up

Go to LFPy’s source code: https://github.com/LFPy/LFPy

Contents

• LFPy
  • Summary
  • Latest changes
  • Usage
  • Code status
  • Conda-forge status
  • Information
  • Citing LFPy
  • Tutorial slides on LFPy
  • Related projects
  • Requirements
  • Installation
  • Uninstall
  • Docker
  • HTML Documentation
  • Physical units in LFPy
• Module LFPy
• Cell classes
  • class Cell
    • Cell
      • Cell.cellpickler()
      • Cell.chiral_morphology()
      • Cell.distort_geometry()
      • Cell.enable_extracellular_stimulation()
      • Cell.get_axial_currents_from_vmem()
      • Cell.get_axial_resistance()
      • Cell.get_closest_idx()
      • Cell.get_dict_of_children_idx()
      • Cell.get_dict_parent_connections()
      • Cell.get_idx()
      • Cell.get_idx_children()
      • Cell.get_idx_name()
      • Cell.get_idx_parent_children()
      • Cell.get_idx_polygons()
      • Cell.get_intersegment_distance()
      • Cell.get_intersegment_vector()
      • Cell.get_multi_current_dipole_moments()
      • Cell.get_pt3d_polygons()
      • Cell.get_rand_idx_area_and_distribution_norm()
      • Cell.get_rand_idx_area_norm()
      • Cell.get_rand_prob_area_norm()
      • Cell.get_rand_prob_area_norm_from_idx()
      • Cell.get_transformation_matrix_vmem_to_imem()
      • Cell.insert_v_ext()
      • Cell.set_point_process()
      • Cell.set_pos()
      • Cell.set_rotation()
      • Cell.set_synapse()
      • Cell.simulate()
      • Cell.strip_hoc_objects()
  • class TemplateCell
    • TemplateCell
      • TemplateCell.cellpickler()
      • TemplateCell.chiral_morphology()
      • TemplateCell.distort_geometry()
      • TemplateCell.enable_extracellular_stimulation()
      • TemplateCell.get_axial_currents_from_vmem()
      • TemplateCell.get_axial_resistance()
      • TemplateCell.get_closest_idx()
      • TemplateCell.get_dict_of_children_idx()
      • TemplateCell.get_dict_parent_connections()
      • TemplateCell.get_idx()
      • TemplateCell.get_idx_children()
      • TemplateCell.get_idx_name()
      • TemplateCell.get_idx_parent_children()
      • TemplateCell.get_idx_polygons()
      • TemplateCell.get_intersegment_distance()
      • TemplateCell.get_intersegment_vector()
      • TemplateCell.get_multi_current_dipole_moments()
      • TemplateCell.get_pt3d_polygons()
      • TemplateCell.get_rand_idx_area_and_distribution_norm()
      • TemplateCell.get_rand_idx_area_norm()
      • TemplateCell.get_rand_prob_area_norm()
      • TemplateCell.get_rand_prob_area_norm_from_idx()
      • TemplateCell.get_transformation_matrix_vmem_to_imem()
      • TemplateCell.insert_v_ext()
      • TemplateCell.set_point_process()
      • TemplateCell.set_pos()
      • TemplateCell.set_rotation()
      • TemplateCell.set_synapse()
      • TemplateCell.simulate()
      • TemplateCell.strip_hoc_objects()
  • class NetworkCell
    • NetworkCell
      • NetworkCell.cellpickler()
      • NetworkCell.chiral_morphology()
      • NetworkCell.create_spike_detector()
      • NetworkCell.create_synapse()
      • NetworkCell.distort_geometry()
      • NetworkCell.enable_extracellular_stimulation()
      • NetworkCell.get_axial_currents_from_vmem()
      • NetworkCell.get_axial_resistance()
      • NetworkCell.get_closest_idx()
      • NetworkCell.get_dict_of_children_idx()
      • NetworkCell.get_dict_parent_connections()
      • NetworkCell.get_idx()
      • NetworkCell.get_idx_children()
      • NetworkCell.get_idx_name()
      • NetworkCell.get_idx_parent_children()
      • NetworkCell.get_idx_polygons()
      • NetworkCell.get_intersegment_distance()
      • NetworkCell.get_intersegment_vector()
      • NetworkCell.get_multi_current_dipole_moments()
      • NetworkCell.get_pt3d_polygons()
      • NetworkCell.get_rand_idx_area_and_distribution_norm()
      • NetworkCell.get_rand_idx_area_norm()
      • NetworkCell.get_rand_prob_area_norm()
      • NetworkCell.get_rand_prob_area_norm_from_idx()
      • NetworkCell.get_transformation_matrix_vmem_to_imem()
      • NetworkCell.insert_v_ext()
      • NetworkCell.set_point_process()
      • NetworkCell.set_pos()
      • NetworkCell.set_rotation()
      • NetworkCell.set_synapse()
      • NetworkCell.simulate()
      • NetworkCell.strip_hoc_objects()
• Point processes
  • class PointProcess
    • PointProcess
      • PointProcess.update_pos()
  • class Synapse
    • Synapse
      • Synapse.collect_current()
      • Synapse.collect_potential()
      • Synapse.set_spike_times()
      • Synapse.set_spike_times_w_netstim()
  • class StimIntElectrode
    • StimIntElectrode
      • StimIntElectrode.collect_current()
      • StimIntElectrode.collect_potential()
• Networks
  • class Network
    • Network
      • Network.connect()
      • Network.create_population()
      • Network.enable_extracellular_stimulation()
      • Network.get_connectivity_rand()
      • Network.simulate()
  • class NetworkPopulation
    • NetworkPopulation
      • NetworkPopulation.draw_rand_pos()
• Forward models
  • class CurrentDipoleMoment
    • CurrentDipoleMoment
      • CurrentDipoleMoment.get_transformation_matrix()
  • class PointSourcePotential
    • PointSourcePotential
      • PointSourcePotential.get_transformation_matrix()
  • class LineSourcePotential
    • LineSourcePotential
      • LineSourcePotential.get_transformation_matrix()
  • class RecExtElectrode
    • RecExtElectrode
      • RecExtElectrode.get_transformation_matrix()
  • class RecMEAElectrode
    • RecMEAElectrode
      • RecMEAElectrode.distort_cell_geometry()
      • RecMEAElectrode.get_transformation_matrix()
  • class OneSphereVolumeConductor
    • OneSphereVolumeConductor
      • OneSphereVolumeConductor.calc_potential()
      • OneSphereVolumeConductor.get_transformation_matrix()
• Current Dipole Moment forward models
  • class InfiniteVolumeConductor
    • InfiniteVolumeConductor
      • InfiniteVolumeConductor.get_dipole_potential()
      • InfiniteVolumeConductor.get_multi_dipole_potential()
      • InfiniteVolumeConductor.get_transformation_matrix()
  • class FourSphereVolumeConductor
    • FourSphereVolumeConductor
      • FourSphereVolumeConductor.get_dipole_potential()
      • FourSphereVolumeConductor.get_dipole_potential_from_multi_dipoles()
      • FourSphereVolumeConductor.get_transformation_matrix()
  • class NYHeadModel
    • NYHeadModel
      • NYHeadModel.find_closest_electrode()
      • NYHeadModel.get_transformation_matrix()
      • NYHeadModel.return_closest_idx()
      • NYHeadModel.rotate_dipole_to_surface_normal()
      • NYHeadModel.set_dipole_pos()
  • class InfiniteHomogeneousVolCondMEG
    • InfiniteHomogeneousVolCondMEG
      • InfiniteHomogeneousVolCondMEG.calculate_B()
      • InfiniteHomogeneousVolCondMEG.calculate_H()
      • InfiniteHomogeneousVolCondMEG.calculate_H_from_iaxial()
      • InfiniteHomogeneousVolCondMEG.get_transformation_matrix()
  • class SphericallySymmetricVolCondMEG
    • SphericallySymmetricVolCondMEG
      • SphericallySymmetricVolCondMEG.calculate_B()
      • SphericallySymmetricVolCondMEG.calculate_H()
      • SphericallySymmetricVolCondMEG.calculate_H_from_iaxial()
      • SphericallySymmetricVolCondMEG.get_transformation_matrix()
• Current Source Density (CSD)
  • class LaminarCurrentSourceDensity
    • LaminarCurrentSourceDensity
      • LaminarCurrentSourceDensity.get_transformation_matrix()
  • class VolumetricCurrentSourceDensity
    • VolumetricCurrentSourceDensity
      • VolumetricCurrentSourceDensity.get_transformation_matrix()
• Misc.
  • submodule lfpcalc
  • submodule tools
    • load()
    • noise_brown()
  • submodule alias_method
    • alias_method()
    • alias_setup()
  • submodule inputgenerators
    • get_activation_times_from_distribution()

Indices and tables

• Index

• Module Index

• Search Page