Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
liuzhenqi77 committed Oct 6, 2023
1 parent d131dc9 commit 497fb2c
Showing 1 changed file with 39 additions and 4 deletions.
43 changes: 39 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,48 @@ the `Brain Imaging Centre <https://www.mcgill.ca/bic/home>`_ at
.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
:target: https://opensource.org/licenses/BSD-3-Clause

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

Usage
-----

Check out our `documentation <https://netneurotools.readthedocs.io/en/latest>`_
for information on how to install and use ``netneurotools``!
for more information!

.. _development:

Expand Down

0 comments on commit 497fb2c

Please sign in to comment.