Tutorials
=========

Welcome to the ``brainmass`` tutorials! These guides will help you get started with whole-brain
network modeling, from installation to advanced parameter fitting.


Learning Path
-------------

We recommend following the tutorials in this order:

.. grid:: 2
   :gutter: 3

   .. grid-item-card:: 1. Installation
      :link: installation
      :link-type: doc

      Set up ``brainmass`` for CPU, GPU, or TPU

   .. grid-item-card:: 2. Quickstart
      :link: quickstart
      :link-type: doc

      5-minute introduction to basic simulations

   .. grid-item-card:: 3. Choosing Models
      :link: choosing_models
      :link-type: doc

      Guide to selecting the right neural mass model

   .. grid-item-card:: 4. Units Guide
      :link: units_guide
      :link-type: doc

      Working with ``brainunit`` for unit-safe computations

   .. grid-item-card:: 5. Building Networks
      :link: building_networks
      :link-type: doc

      Create multi-region brain networks

   .. grid-item-card:: 6. Adding Coupling
      :link: adding_coupling
      :link-type: doc

      Connect regions with coupling mechanisms

   .. grid-item-card:: 7. Forward Modeling
      :link: forward_modeling
      :link-type: doc

      Map neural activity to BOLD, EEG, MEG signals

   .. grid-item-card:: 8. Parameter Fitting
      :link: parameter_fitting
      :link-type: doc

      Optimize model parameters to match data


Getting Help
------------

If you encounter issues:

- Check the :doc:`../faq` for common problems
- Browse the :doc:`../examples/index` for practical examples
- Consult the :doc:`../api/index` for detailed API reference
- Open an issue on `GitHub <https://github.com/chaobrain/brainmass/issues>`_


.. toctree::
   :maxdepth: 2
   :hidden:

   installation
   quickstart
   choosing_models
   units_guide
   building_networks
   adding_coupling
   forward_modeling
   parameter_fitting

