From e94460242219da1b69c4804b63c7bb5574397327 Mon Sep 17 00:00:00 2001 From: j1c Date: Sun, 7 Apr 2024 19:58:48 -0400 Subject: [PATCH] Update documentation --- docs/{pipeline => }/diffusion.rst | 0 docs/{tutorials => }/funcref.rst | 0 docs/{pipeline => }/functional.rst | 0 docs/index.rst | 37 ++++++++++++++---------------- docs/{tutorials => }/install.rst | 0 5 files changed, 17 insertions(+), 20 deletions(-) rename docs/{pipeline => }/diffusion.rst (100%) rename docs/{tutorials => }/funcref.rst (100%) rename docs/{pipeline => }/functional.rst (100%) rename docs/{tutorials => }/install.rst (100%) diff --git a/docs/pipeline/diffusion.rst b/docs/diffusion.rst similarity index 100% rename from docs/pipeline/diffusion.rst rename to docs/diffusion.rst diff --git a/docs/tutorials/funcref.rst b/docs/funcref.rst similarity index 100% rename from docs/tutorials/funcref.rst rename to docs/funcref.rst diff --git a/docs/pipeline/functional.rst b/docs/functional.rst similarity index 100% rename from docs/pipeline/functional.rst rename to docs/functional.rst diff --git a/docs/index.rst b/docs/index.rst index 3256b3125..2f1f98745 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,34 +1,30 @@ -.. m2g documentation master file, created by - sphinx-quickstart on Wed Dec 19 13:35:38 2018. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. -*- coding: utf-8 -*- -.. _BiorXiv: https://www.biorxiv.org/content/early/2018/04/24/188706 +.. _contents: -m2g +.. _BiorXiv: https://doi.org/10.1101/2021.11.01.466686 + +Overview of m2g ================================ -NeuroData’s MR Graphs package, m2g (pronounced “nutmeg”), is the successor of the MRCAP, MIGRAINE, and m2g pipelines. m2g combines dMRI and sMRI data from a single subject to estimate a high-level connectome reliably and scalably. +NeuroData’s MR Graphs package, `m2g`, is the successor of the MRCAP, MIGRAINE, and m2g pipelines. m2g combines dMRI, fMRI, and sMRI data from a single subject to estimate a high-level connectome reliably and scalably. The m2g pipeline has been developed as a one-click solution for human connectome estimation by providing robust and reliable estimates of connectivity across a wide range of datasets. The pipelines are explained and derivatives analyzed in our pre-print, available on BiorXiv_. -.. toctree:: - :caption: Tutorials - :maxdepth: 3 +Free software +------------- - tutorials/install - tutorials/funcref +m2g is free software; you can redistribute it and/or modify it under the +terms of the :doc:`Polyform ` license. We welcome contributions. +Join us on `GitHub `_. .. toctree:: - :caption: Pipeline Overview - :maxdepth: 2 - - pipeline/diffusion - pipeline/functional + :caption: Documentation + :maxdepth: 3 -.. toctree:: - :caption: Function Reference - :maxdepth: 1 + install + diffusion + functional .. toctree:: :maxdepth: 1 @@ -37,3 +33,4 @@ The m2g pipeline has been developed as a one-click solution for human connectome m2g @ GitHub m2g @ PyPI Issue Tracker + NeuroData Lab \ No newline at end of file diff --git a/docs/tutorials/install.rst b/docs/install.rst similarity index 100% rename from docs/tutorials/install.rst rename to docs/install.rst