:orphan:

.. _examples:

Examples
========

Runnable, commented examples for **PyAMICA**.

Run on your own data
--------------------

For EEG data, start from ``01_mne_integration.py`` to fit AMICA on an MNE raw object.

If your data is already a NumPy array with shape ``(n_channels, n_samples)``, use ``02_pure_jax_fitting.py``.

Installation
------------

From a local clone: ``pip install -e ".[all]"``

JAX uses an available GPU automatically when the compatible GPU package is installed; otherwise it runs on CPU.


.. 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 shows how to fit AMICA through the amica.fit_ica wrapper.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_01_mne_integration_thumb.png
    :alt:

  :doc:`/auto_examples/01_mne_integration`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">AMICA via MNE-Python</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to configure amica.AmicaConfig and fit AMICA directly on a NumPy array.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_02_pure_jax_fitting_thumb.png
    :alt:

  :doc:`/auto_examples/02_pure_jax_fitting`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Pure-JAX AMICA on a NumPy array</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/01_mne_integration
   /auto_examples/02_pure_jax_fitting


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_