Welcome to OPM-Python's documentation!
=================================
`OPM-Python <https://github.com/LiaoPan/opm-python>`_ is a convenient preprocessing tool for OPM-MEG.

Features
---------

.. grid::

   .. grid-item::
      :columns: 12 12 12 6

      .. card:: Reliability and Robustness
         :class-card: sd-border-0
         :shadow: none
         :class-title: sd-fs-5

         .. div:: sd-font-normal

            OPM-Python is designed for reliable and consistent data analysis results.

   .. grid-item::
      :columns: 12 12 12 6

      .. card:: Modularity and Integrability
         :class-card: sd-border-0
         :shadow: none
         :class-title: sd-fs-5

         .. div:: sd-font-normal

            OPM-Python is implemented in modular fashion and provides command-line tools, as well as functional interfaces for easy integration into third-party software.

   .. grid-item::
      :columns: 12 12 12 6

      .. card:: Minimal preprocessing
         :class-card: sd-border-0
         :shadow: none
         :class-title: sd-fs-5

         .. div:: sd-font-normal

            OPM-Python workflows should be as minimal as possible to process the original data or their minimally processed derivatives.

   .. grid-item::
      :columns: 12 12 12 6

      .. card:: Interpretability and standards
         :class-card: sd-border-0
         :shadow: none
         :class-title: sd-fs-5

         .. div:: sd-font-normal

            OPM-Python provides detailed tutorials and documentation to help users quickly get started with OPM data analysis.

.. grid::

   .. grid-item::
      :columns: 6 6 6 4

      .. card:: :material-regular:`rocket_launch;2em` Installation
         :class-card: sd-text-black sd-bg-light
         :link: quickstart/installation.html

   .. grid-item::
      :columns: 6 6 6 4

      .. card:: :material-regular:`bolt;2em` Guide for Beginner
         :class-card: sd-text-black sd-bg-light
         :link: quickstart/quick_guide.html

   .. grid-item::
      :columns: 6 6 6 4

      .. card:: :material-regular:`library_books;2em` Concepts
         :class-card: sd-text-black sd-bg-light
         :link: tutorial/concepts.html

   .. grid-item::
      :columns: 6 6 6 4

      .. card:: :material-regular:`terminal;2em` Command Tools
         :class-card: sd-text-black sd-bg-light
         :link: quickstart/cmd.html


   .. grid-item::
      :columns: 6 6 6 4

      .. card:: :material-regular:`webhook;2em` API documentation
         :class-card: sd-text-black sd-bg-light
         :link: apis/opm-python.html



.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Quickstart

   quickstart/installation
   quickstart/quick_guide.rst
   quickstart/cmd.rst

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Tutorials

   tutorial/preprep.rst
   tutorial/coregistration.rst
   tutorial/source_imaging.rst
   apis/opmpy.rst
..   tutorial/example_opm.rst