Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Update readme & docs #75

Merged
merged 2 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 35 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,44 @@
.. image:: neuromaps_logo.png
.. image:: https://github.com/netneurolab/neuromaps/raw/main/docs/_static/neuromaps_logo.png

|

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

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

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

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

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

|

The ``neuromaps`` toolbox is designed to help researchers make easy,
statistically-rigorous comparisons between brain maps (or brain annotations).
Documentation can be found `here <https://netneurolab.github.io/neuromaps/>`_.

The accompanying paper is published in `Nature Methods <https://www.nature.com/articles/s41592-022-01625-w>`_.
The accompanying paper is published in `Nature Methods <https://www.nature.com/articles/s41592-022-01625-w>`_ (`postprint <https://github.com/netneurolab/neuromaps/blob/main/markello2022natmethods.pdf>`_).

Features
--------

- A growing library of brain maps ("annotations") in their original coordinate space, including microstructure, function, electrophysiology, receptors, and more
- Robust transforms between MNI-152, fsaverage, fsLR, and CIVET spaces
- Integrated spatial null models for statistically assessing correspondences between brain maps

.. image:: https://github.com/netneurolab/neuromaps/raw/main/docs/_static/neuromaps_features.png

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

Installation requirements
-------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ clean:
rm -rf generated/

html-noplot:
$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

Expand Down
Binary file added docs/_static/neuromaps_features.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed neuromaps_logo.png
Binary file not shown.