Skip to content

Commit 173c262

Browse files
committed
enh: revise README.rst
1 parent 9e13b0e commit 173c262

File tree

3 files changed

+32
-97
lines changed

3 files changed

+32
-97
lines changed

README.rst

Lines changed: 31 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -6,73 +6,39 @@ dmriprep
66
.. image:: https://img.shields.io/pypi/v/dmriprep.svg
77
:target: https://pypi.python.org/pypi/dmriprep
88

9-
.. image:: https://img.shields.io/travis/akeshavan/dmriprep.svg
10-
:target: https://travis-ci.org/akeshavan/dmriprep
11-
129
.. image:: https://readthedocs.org/projects/dmriprep/badge/?version=latest
1310
:target: https://dmriprep.readthedocs.io/en/latest/?badge=latest
1411
:alt: Documentation Status
1512

1613

17-
18-
19-
Preprocessing of neuroimaging data in preparation for AFQ analysis
20-
21-
22-
* Free software: BSD license
23-
* Documentation: https://dmriprep.readthedocs.io.
24-
25-
26-
Features
27-
--------
28-
29-
* TODO
30-
31-
32-
Contributing
33-
------------
34-
35-
We love contributions! dmriprep is open source, built on open source,
36-
and we'd love to have you hang out in our community.
37-
38-
We have developed some `guidelines`_ for contributing to dmriprep.
39-
40-
**Imposter syndrome disclaimer**: We want your help. No, really.
41-
42-
There may be a little voice inside your head that is telling you that
43-
you're not ready to be an open source contributor; that your skills
44-
aren't nearly good enough to contribute. What could you possibly offer a
45-
project like this one?
46-
47-
We assure you - the little voice in your head is wrong. If you can
48-
write code at all, you can contribute code to open source. Contributing
49-
to open source projects is a fantastic way to advance one's coding
50-
skills. Writing perfect code isn't the measure of a good developer (that
51-
would disqualify all of us!); it's trying to create something, making
52-
mistakes, and learning from those mistakes. That's how we all improve,
53-
and we are happy to help others learn.
54-
55-
Being an open source contributor doesn't just mean writing code, either.
56-
You can help out by writing documentation, tests, or even giving
57-
feedback about the project (and yes - that includes giving feedback
58-
about the contribution process). Some of these contributions may be the
59-
most valuable to the project as a whole, because you're coming to the
60-
project with fresh eyes, so you can see the errors and assumptions that
61-
seasoned contributors have glossed over.
62-
63-
64-
Credits
65-
-------
66-
67-
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
68-
69-
The imposter syndrome disclaimer was originally written by `Adrienne
70-
Lowe`_ for a `PyCon talk`_, and was adapted based on its use in the
71-
README file for the `MetPy project`_.
72-
73-
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
74-
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
75-
.. _`Adrienne Lowe`: https://github.com/adriennefriend
76-
.. _`Pycom talk`: https://www.youtube.com/watch?v=6Uj746j9Heo
77-
.. _`MetPy project`: https://github.com/Unidata/MetPy
78-
.. _`guidelines`: CONTRIBUTING.rst
14+
Preprocessing of diffusion MRI (dMRI) involves numerous steps to clean and standardize
15+
the data before fitting a particular model.
16+
Generally, researchers create ad hoc preprocessing workflows for each dataset,
17+
building upon a large inventory of available tools.
18+
The complexity of these workflows has snowballed with rapid advances in
19+
acquisition and processing.
20+
dMRIPrep is an analysis-agnostic tool that addresses the challenge of robust and
21+
reproducible preprocessing for whole-brain dMRI data.
22+
dMRIPrep automatically adapts a best-in-breed workflow to the idiosyncrasies of
23+
virtually any dataset, ensuring high-quality preprocessing without manual intervention.
24+
dMRIPrep equips neuroscientists with an easy-to-use and transparent preprocessing
25+
workflow, which can help ensure the validity of inference and the interpretability
26+
of results.
27+
28+
The workflow is based on `Nipype <https://nipype.readthedocs.io>`_ and encompases a large
29+
set of tools from well-known neuroimaging packages, including
30+
`FSL <https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/>`_,
31+
`ANTs <https://stnava.github.io/ANTs/>`_,
32+
`FreeSurfer <https://surfer.nmr.mgh.harvard.edu/>`_,
33+
`AFNI <https://afni.nimh.nih.gov/>`_,
34+
and `Nilearn <https://nilearn.github.io/>`_.
35+
This pipeline was designed to provide the best software implementation for each state of
36+
preprocessing, and will be updated as newer and better neuroimaging software becomes
37+
available.
38+
39+
dMRIPrep performs basic preprocessing steps (coregistration, normalization, unwarping,
40+
segmentation, skullstripping etc.) providing outputs that can be
41+
easily submitted to a variety of tractography algorithms.
42+
43+
[Documentation `dmriprep.org <https://dmriprep.readthedocs.io>`_]
44+
[Support `neurostars.org <https://neurostars.org/tags/fmriprep>`_]

long_description.rst

Lines changed: 0 additions & 31 deletions
This file was deleted.

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author_email = [email protected]
55
maintainer = Oscar Esteban
66
maintainer_email = [email protected]
77
description = dMRIPrep is a robust and easy-to-use pipeline for preprocessing of diverse dMRI data.
8-
long_description = file:long_description.rst
8+
long_description = file:README.rst
99
long_description_content_type = text/x-rst; charset=UTF-8
1010
license = 3-clause BSD
1111
classifiers =

0 commit comments

Comments
 (0)