netneurotools


Namenetneurotools JSON
Version 0.2.5 PyPI version JSON
download
home_pageNone
SummaryA toolbox for network neuroscience
upload_time2024-11-08 17:18:26
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseBSD 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.
keywords network neuroscience connectomics
VCS
bugtrack_url
requirements bctpy matplotlib nibabel nilearn numpy scikit-learn scipy matplotlib tqdm
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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 <netneurolab.github.io/>`_, housed in
the `Brain Imaging Centre <https://www.mcgill.ca/bic/home>`_ at
`McGill University <https://www.mcgill.ca/>`_.

.. _installation:

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

Install directly from PyPi with :code:`pip install netneurotools` or install the main branch with

.. code-block:: bash

    git clone https://github.com/netneurolab/netneurotools.git
    cd netneurotools
    pip install .

.. _features:

Features
--------

*  Network neuroscience metrics: up-to-date and optimized

   *  Network communication
   *  Null networks

*  Brain plotting functions: easy to use and customize

   *  Surface visualization 
      `plot_fsaverage <https://netneurotools.readthedocs.io/en/latest/generated/netneurotools.plotting.plot_fsaverage.html>`_ 
      and `plot_fslr <https://netneurotools.readthedocs.io/en/latest/generated/netneurotools.plotting.plot_fslr.html>`_
   *  3D point brain `plot_point_brain <https://netneurotools.readthedocs.io/en/latest/generated/netneurotools.plotting.plot_point_brain.html>`_
   *  Sorted communities `plot_mod_heatmap <https://netneurotools.readthedocs.io/en/latest/generated/netneurotools.plotting.plot_mod_heatmap.html>`_

*  Statistics functions

   *  Dominance analysis `get_dominance_stats <https://netneurotools.readthedocs.io/en/latest/generated/netneurotools.stats.get_dominance_stats.html>`_

*  Fetchers for common datasets

*  Utilities for working with FreeSurfer and CIVET


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

.. _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:: ✨

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "netneurotools",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Network Neuroscience Lab <netneurotools-aaaaba25hq3jdluwb2z5h2yr3e@netneurolab.slack.com>",
    "keywords": "network neuroscience, connectomics",
    "author": null,
    "author_email": "Network Neuroscience Lab <netneurotools-aaaaba25hq3jdluwb2z5h2yr3e@netneurolab.slack.com>",
    "download_url": "https://files.pythonhosted.org/packages/bd/74/59ff631cf6c3f3de4d1796052b490fdde59b110b8e12fe16a6832bb70d3f/netneurotools-0.2.5.tar.gz",
    "platform": null,
    "description": "netneurotools: Tools for network neuroscience\n=============================================\n\n|\n\n.. .. image:: https://zenodo.org/badge/375755159.svg\n..    :target: https://zenodo.org/badge/latestdoi/375755159\n..    :alt: Zenodo record\n\n.. image:: https://img.shields.io/pypi/v/netneurotools\n   :target: https://pypi.python.org/pypi/netneurotools/\n   :alt: Latest PyPI version\n\n.. image:: https://img.shields.io/badge/docker-netneurolab/netneurotools-brightgreen.svg?logo=docker&style=flat\n  :target: https://hub.docker.com/r/netneurolab/netneurotools/tags/\n  :alt: Latest Docker image\n\n.. image:: https://github.com/netneurolab/netneurotools/actions/workflows/tests.yml/badge.svg\n  :target: https://github.com/netneurolab/netneurotools/actions/workflows/tests.yml\n  :alt: run-tests status\n\n.. image:: https://github.com/netneurolab/netneurotools/actions/workflows/docs.yml/badge.svg\n  :target: https://netneurolab.github.io/netneurotools/\n  :alt: deploy-docs status\n\n|\n\nThis toolbox is a collection of functions written in Python that get frequent\nusage in the `Network Neuroscience Lab <netneurolab.github.io/>`_, housed in\nthe `Brain Imaging Centre <https://www.mcgill.ca/bic/home>`_ at\n`McGill University <https://www.mcgill.ca/>`_.\n\n.. _installation:\n\nInstallation\n------------\n\nInstall directly from PyPi with :code:`pip install netneurotools` or install the main branch with\n\n.. code-block:: bash\n\n    git clone https://github.com/netneurolab/netneurotools.git\n    cd netneurotools\n    pip install .\n\n.. _features:\n\nFeatures\n--------\n\n*  Network neuroscience metrics: up-to-date and optimized\n\n   *  Network communication\n   *  Null networks\n\n*  Brain plotting functions: easy to use and customize\n\n   *  Surface visualization \n      `plot_fsaverage <https://netneurotools.readthedocs.io/en/latest/generated/netneurotools.plotting.plot_fsaverage.html>`_ \n      and `plot_fslr <https://netneurotools.readthedocs.io/en/latest/generated/netneurotools.plotting.plot_fslr.html>`_\n   *  3D point brain `plot_point_brain <https://netneurotools.readthedocs.io/en/latest/generated/netneurotools.plotting.plot_point_brain.html>`_\n   *  Sorted communities `plot_mod_heatmap <https://netneurotools.readthedocs.io/en/latest/generated/netneurotools.plotting.plot_mod_heatmap.html>`_\n\n*  Statistics functions\n\n   *  Dominance analysis `get_dominance_stats <https://netneurotools.readthedocs.io/en/latest/generated/netneurotools.stats.get_dominance_stats.html>`_\n\n*  Fetchers for common datasets\n\n*  Utilities for working with FreeSurfer and CIVET\n\n\nCheck out our `documentation <https://netneurotools.readthedocs.io/en/latest>`_\nfor more information!\n\n.. _development:\n\nDevelopment\n-----------\n\nThis package has been developed by members of the Network Neuroscience Lab in\npursuit of their research. While we've made every effort to ensure these tools\nwork and have some documentation, there is always room for improvement! If\nyou've found a bug, are experiencing a problem, or have a question, create a\nnew `issue <https://github.com/netneurolab/netneurotools/issues>`_ with some\ninformation about it and one of our team members will do our best to help you.\n\n.. _licensing:\n\nLicense Information\n-------------------\n\nThis codebase is licensed under the 3-clause BSD license. The full license can\nbe found in the `LICENSE <https://github.com/netneurolab/netneurotools/blob/\nmaster/LICENSE>`_ file in the ``netneurotools`` distribution.\n\nAll trademarks referenced herein are property of their respective holders.\n\n.. |sparkles| replace:: \u2728\n",
    "bugtrack_url": null,
    "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. ",
    "summary": "A toolbox for network neuroscience",
    "version": "0.2.5",
    "project_urls": {
        "Homepage": "https://github.com/netneurolab/netneurotools"
    },
    "split_keywords": [
        "network neuroscience",
        " connectomics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "10225c4f21534a0b44c69ff4546693e30fdfd6d0c2d39f48d02e64a5a9c10872",
                "md5": "171ff7e817a114091a7463fd3c408324",
                "sha256": "8cff1a676a6c0fbe4c309d2c196a36835c5455f5461e992688e705eb1ac1b403"
            },
            "downloads": -1,
            "filename": "netneurotools-0.2.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "171ff7e817a114091a7463fd3c408324",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 94867,
            "upload_time": "2024-11-08T17:18:24",
            "upload_time_iso_8601": "2024-11-08T17:18:24.808769Z",
            "url": "https://files.pythonhosted.org/packages/10/22/5c4f21534a0b44c69ff4546693e30fdfd6d0c2d39f48d02e64a5a9c10872/netneurotools-0.2.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bd7459ff631cf6c3f3de4d1796052b490fdde59b110b8e12fe16a6832bb70d3f",
                "md5": "ab2f9438eb9b36eddfad106bd115c2d8",
                "sha256": "3579011c264824d0ea24c5292c7a5d92663049fdf838cdc3e575a098fd3bdcf2"
            },
            "downloads": -1,
            "filename": "netneurotools-0.2.5.tar.gz",
            "has_sig": false,
            "md5_digest": "ab2f9438eb9b36eddfad106bd115c2d8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 106313,
            "upload_time": "2024-11-08T17:18:26",
            "upload_time_iso_8601": "2024-11-08T17:18:26.765670Z",
            "url": "https://files.pythonhosted.org/packages/bd/74/59ff631cf6c3f3de4d1796052b490fdde59b110b8e12fe16a6832bb70d3f/netneurotools-0.2.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-08 17:18:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "netneurolab",
    "github_project": "netneurotools",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "bctpy",
            "specs": []
        },
        {
            "name": "matplotlib",
            "specs": []
        },
        {
            "name": "nibabel",
            "specs": []
        },
        {
            "name": "nilearn",
            "specs": []
        },
        {
            "name": "numpy",
            "specs": [
                [
                    ">=",
                    "1.16"
                ]
            ]
        },
        {
            "name": "scikit-learn",
            "specs": []
        },
        {
            "name": "scipy",
            "specs": [
                [
                    ">=",
                    "1.4.0"
                ]
            ]
        },
        {
            "name": "matplotlib",
            "specs": [
                [
                    ">=",
                    "3.3.0"
                ]
            ]
        },
        {
            "name": "tqdm",
            "specs": []
        }
    ],
    "lcname": "netneurotools"
}
        
Elapsed time: 4.06298s