Metadata-Version: 2.4
Name: netneurotools
Version: 0.3.0
Summary: A toolbox for network neuroscience
Author-email: Network Neuroscience Lab <netneurotools-aaaaba25hq3jdluwb2z5h2yr3e@netneurolab.slack.com>
Maintainer-email: Network Neuroscience Lab <netneurotools-aaaaba25hq3jdluwb2z5h2yr3e@netneurolab.slack.com>
License: BSD 3-Clause License
        
        Copyright (c) 2018, Network Neuroscience Lab
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/netneurolab/netneurotools
Keywords: network neuroscience,connectomics
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: bctpy
Requires-Dist: numpy>=1.16
Requires-Dist: scipy>=1.4.0
Requires-Dist: matplotlib
Requires-Dist: scikit-learn
Requires-Dist: nibabel>=3.0.0
Requires-Dist: nilearn
Requires-Dist: tqdm
Provides-Extra: doc
Requires-Dist: sphinx>=2.0; extra == "doc"
Requires-Dist: sphinx_rtd_theme; extra == "doc"
Requires-Dist: sphinx-gallery; extra == "doc"
Provides-Extra: pysurfer
Requires-Dist: vtk; extra == "pysurfer"
Requires-Dist: mayavi; extra == "pysurfer"
Requires-Dist: pysurfer; extra == "pysurfer"
Provides-Extra: pyvista
Requires-Dist: vtk; extra == "pyvista"
Requires-Dist: pyvista; extra == "pyvista"
Provides-Extra: numba
Requires-Dist: numba; extra == "numba"
Provides-Extra: style
Requires-Dist: flake8; extra == "style"
Requires-Dist: ruff; extra == "style"
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: pytest>=3.6; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Dynamic: license-file

netneurotools: Tools for network neuroscience
=============================================

|

.. .. image:: https://zenodo.org/badge/375755159.svg
..    :target: https://zenodo.org/badge/latestdoi/375755159
..    :alt: Zenodo record

.. image:: https://img.shields.io/pypi/v/netneurotools
   :target: https://pypi.python.org/pypi/netneurotools/
   :alt: Latest PyPI version

.. image:: https://img.shields.io/badge/docker-netneurolab/netneurotools-brightgreen.svg?logo=docker&style=flat
  :target: https://hub.docker.com/r/netneurolab/netneurotools/tags/
  :alt: Latest Docker image

.. image:: https://github.com/netneurolab/netneurotools/actions/workflows/tests.yml/badge.svg
  :target: https://github.com/netneurolab/netneurotools/actions/workflows/tests.yml
  :alt: run-tests status

.. image:: https://github.com/netneurolab/netneurotools/actions/workflows/docs.yml/badge.svg
  :target: https://netneurolab.github.io/netneurotools/
  :alt: deploy-docs status

|

This toolbox is a collection of functions written in Python that get frequent
usage in the `Network Neuroscience Lab <https://netneurolab.github.io/>`_, housed in
the `Brain Imaging Centre <https://www.mcgill.ca/bic/home>`_ at
`McGill University <https://www.mcgill.ca/>`_.


.. _features:

Features
--------

Netneurotools provides a wide range of tools for network neuroscience research.

*  A range of useful datasets fetchers

*  Network construction: empirical and surrogate

*  Network (graph) metrics calculation: up-to-date and optimized

*  Brain and network visualization

*  Optimized statistics routines

*  Convenient interface for external tools

*  And much more!


Check out our `documentation <https://netneurotools.readthedocs.io/en/latest>`_
for more information!


.. _installation:

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

You can install directly from PyPi with :code:`pip install netneurotools`.

This package is under active development. We recommend installing the latest version
with 

.. code-block:: bash

    pip install git+https://github.com/netneurolab/netneurotools.git


If you are looking for the earlier version of the toolbox before the recent breaking changes,
you can install it with

.. code-block:: bash

    pip install git+https://github.com/netneurolab/netneurotools.git@0.2.X


.. _development:

Development
-----------

This package has been developed by members of the Network Neuroscience Lab in
pursuit of their research. While we've made every effort to ensure these tools
work and have some documentation, there is always room for improvement! If
you've found a bug, are experiencing a problem, or have a question, create a
new `issue <https://github.com/netneurolab/netneurotools/issues>`_ with some
information about it and one of our team members will do our best to help you.


.. _licensing:

License Information
-------------------

This codebase is licensed under the 3-clause BSD license. The full license can
be found in the `LICENSE <https://github.com/netneurolab/netneurotools/blob/
master/LICENSE>`_ file in the ``netneurotools`` distribution.

All trademarks referenced herein are property of their respective holders.

.. |sparkles| replace:: ✨
