NLTools
=======

.. image:: https://img.shields.io/pypi/v/nltools.svg
    :target: https://pypi.org/project/nltools/

.. image:: https://github.com/cosanlab/nltools/actions/workflows/auto_formatting_tests_and_coverage.yml/badge.svg
    :target: https://github.com/cosanlab/nltools/actions/workflows/auto_formatting_tests_and_coverage.yml

.. image:: https://codecov.io/gh/cosanlab/nltools/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/cosanlab/nltools

.. image:: https://app.codacy.com/project/badge/Grade/f118dc39e5df46d28e80d0d326721cbb
    :target: https://app.codacy.com/gh/cosanlab/nltools/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2229813.svg
    :target: https://doi.org/10.5281/zenodo.2229813

.. image:: https://img.shields.io/badge/python-3.7%20%7C%203.8-blue
    :target: https://nltools.org

.. image:: https://img.shields.io/badge/platform-linux%20%7C%20osx%20%7C%20win-blue
    :target: https://nltools.org

`NLTools <https://github.com/ljchang/neurolearn>`_ is a Python package for analyzing neuroimaging data.  It is the analysis engine powering `neuro-learn <http://neuro-learn.org>`_ There are tools to perform data manipulation and analyses such as univariate GLMs, predictive multivariate modeling, and representational similarity analyses.  It is based loosely off of Tor Wager's `object-oriented Matlab toolbox <https://github.com/canlab/CanlabCore>`_ and leverages much code from `nilearn <http://nilearn.github.io/>`_ and  `scikit-learn <http://scikit-learn.org>`_

Watch a video in which Dr. Eshin Jolly, PhD outlines some of the design principles behind nltools at SciPy 2020.

.. raw:: html

   <div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden; max-width: 100%; height: auto;">
        <iframe src="https://www.youtube.com/embed/1c1AnXLs7xM" frameborder="0" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe>
   </div>

Learn how to use nltools with hands on tutorials:

- `DartBrains <https://dartbrains.org/>`_ is an introductory neuroimaging analysis course that uses nltools. 
- `Naturalistic-Data <http://naturalistic-data.org/>`_ is a course covering advanced methods for analyzing naturalistic data. Many of the tutorials use functions from nltools.