.. _sphx_glr_auto_examples_howto:

How to
------

These are short examples that show how to use HNN-core API to accomplish specific
tasks.


.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to inspect the firing pattern of cells in the HNN model.">

.. only:: html

  .. image:: /auto_examples/howto/images/thumb/sphx_glr_plot_firing_pattern_thumb.png
    :alt:

  :doc:`/auto_examples/howto/plot_firing_pattern`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">01. Plot firing pattern</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The main output of HNN simulations is the &#x27;dipole&#x27; waveform, i.e., the net intracellular current flowing in pyramidal cell apical dendrites. At the large distances between cells and M/EEG sensors, this &#x27;primary&#x27; current is the main contributor to the measured fields. Close to the cells, the local field potential (LFP) is the result of intracellular current leaking into the extracellular medium through active and passive membrane channels. Under some simplifying assumptions, we may approximate the LFP at virtual electrodes placed in and around the HNN network model.">

.. only:: html

  .. image:: /auto_examples/howto/images/thumb/sphx_glr_plot_record_extracellular_potentials_thumb.png
    :alt:

  :doc:`/auto_examples/howto/plot_record_extracellular_potentials`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">02. Record extracellular potentials</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to modify the network connectivity.">

.. only:: html

  .. image:: /auto_examples/howto/images/thumb/sphx_glr_plot_connectivity_thumb.png
    :alt:

  :doc:`/auto_examples/howto/plot_connectivity`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">03. Modifying local connectivity</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use the MPI backend for simulating dipoles using HNN-core.">

.. only:: html

  .. image:: /auto_examples/howto/images/thumb/sphx_glr_plot_simulate_mpi_backend_thumb.png
    :alt:

  :doc:`/auto_examples/howto/plot_simulate_mpi_backend`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">04. Use MPI backend for parallelization</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to optimize the parameters of the model simulation to match an experimental dipole waveform.">

.. only:: html

  .. image:: /auto_examples/howto/images/thumb/sphx_glr_optimize_evoked_thumb.png
    :alt:

  :doc:`/auto_examples/howto/optimize_evoked`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">05. Optimize simulated evoked response parameters</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to animate HNN simulations">

.. only:: html

  .. image:: /auto_examples/howto/images/thumb/sphx_glr_plot_hnn_animation_thumb.png
    :alt:

  :doc:`/auto_examples/howto/plot_hnn_animation`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">06. Animating HNN simulations</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to do batch simulations in HNN-core, allowing users to efficiently run multiple simulations with different parameters for comprehensive analysis.">

.. only:: html

  .. image:: /auto_examples/howto/images/thumb/sphx_glr_plot_batch_simulate_thumb.png
    :alt:

  :doc:`/auto_examples/howto/plot_batch_simulate`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">07. Batch Simulation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to optimize the power spectral density (PSD) of a current dipole signal with significant alpha and beta spectral components.">

.. only:: html

  .. image:: /auto_examples/howto/images/thumb/sphx_glr_optimize_rhythmic_thumb.png
    :alt:

  :doc:`/auto_examples/howto/optimize_rhythmic`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">08. Optimize simulated rhythmic responses</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Welcome to this hands-on tutorial on simulating communication between two neocortical networks using HNN-Core! This notebook guides you through creating a source network (Network A), extracting its spike data, feeding it into a target network (Network B) using the add_spike_train_drive method, simulating both, and visualizing the results. Let&#x27;s dive in!">

.. only:: html

  .. image:: /auto_examples/howto/images/thumb/sphx_glr_plot_replaying_spike_data_as_input_thumb.png
    :alt:

  :doc:`/auto_examples/howto/plot_replaying_spike_data_as_input`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">09. Replaying Spike Data as Input</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/howto/plot_firing_pattern
   /auto_examples/howto/plot_record_extracellular_potentials
   /auto_examples/howto/plot_connectivity
   /auto_examples/howto/plot_simulate_mpi_backend
   /auto_examples/howto/optimize_evoked
   /auto_examples/howto/plot_hnn_animation
   /auto_examples/howto/plot_batch_simulate
   /auto_examples/howto/optimize_rhythmic
   /auto_examples/howto/plot_replaying_spike_data_as_input