Skip to content
This repository was archived by the owner on Dec 27, 2022. It is now read-only.

Commit b4c9605

Browse files
committed
Rename all preafq stuff to dmriprep.
Addresses #7.
1 parent a6a407c commit b4c9605

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+158
-155
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
* preAFQ version:
1+
* dmriprep version:
22
* Python version:
33
* Operating System:
44

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,3 +100,6 @@ ENV/
100100

101101
# mypy
102102
.mypy_cache/
103+
104+
# Mac OS nonsense:
105+
.DS_Store

.travis.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ node_js:
44
- '6.0'
55
cache:
66
directories:
7-
- preafqViewer/node_modules
7+
- dmriprepViewer/node_modules
88
branches:
99
only:
1010
- master
1111
notifications:
1212
email: false
1313
before_script:
14-
- cd preafqViewer
14+
- cd dmriprepViewer
1515
- npm prune
1616
script:
1717
- npm install
@@ -21,6 +21,6 @@ after_success:
2121
- bash ./deploy.sh
2222
env:
2323
global:
24-
- GH_USER: akeshavan
25-
- GH_REPO: preAFQ
24+
- GH_USER: nipy
25+
- GH_REPO: dmriprep
2626
- secure: irToFjVhLgr3rOdobRrhpJqSJtamvDTiBHmq4Xr1m3G24rirSRqSEjp6zronYbyNJ/VnoIhc0L8/VKrDUNsGR+0zqwJ4b4/2nR7LG7grvH79hWz2zGOckm2oYFC0BKyCFSiJ4n5op5SVslARr2ONgO+BqtclBIVAyHcbfnRMhHawZvcaWDgUOeLT8cTCT3uddOWNRQY1bH+nwv7OjqpQHlvLTAXjSH7XdVoGnzPhK79F1djUrpzJSODcsZl+VU1ghVKc1fj8AEpha0m3ZF0dSRK9xYBXOYaoXsbjXjDMo2kZJd8vobZ2Tvl9WP8xpEEJjqFMRxqDCd9JZq9kr/vVWpirm7mWce65BiJBj7K2iBwWjruqeLhYLcM8bdIEDybTqV8ZeXeghcbBpw+L+5hgSHbEK+XZFmTO9XKOpF0XhvYjxpti8cv2PIJ6Dhg+j+LrAo3MkRuYZ19DgKdId4fr+PM6Fuxfwa/h0AkL2bKampeofrbRQZDS/Q2TxTfp4UaxMYhLWLoJqZFYsdcLIPjlmMPSTvvnWq+YJ8bHxqrdORiUKDY32uXQ/LBFrQVjgZJFzR7OOazWcxykpBMYJh5sH1A6a52xJj26heygM2CxPGdwzapFM1XmS0QZ+qeGVYx9YMSD+oBxgpHj3xQorvon+YEiSdnTeyLWKq7sTciTAPM=

CONTRIBUTING.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Types of Contributions
1515
Report Bugs
1616
~~~~~~~~~~~
1717

18-
Report bugs at https://github.com/akeshavan/preafq/issues.
18+
Report bugs at https://github.com/nipy/dmriprep/issues.
1919

2020
If you are reporting a bug, please include:
2121

@@ -38,14 +38,14 @@ and "help wanted" is open to whoever wants to implement it.
3838
Write Documentation
3939
~~~~~~~~~~~~~~~~~~~
4040

41-
preAFQ could always use more documentation, whether as part of the
42-
official preAFQ docs, in docstrings, or even on the web in blog posts,
41+
dmriprep could always use more documentation, whether as part of the
42+
official dmriprep docs, in docstrings, or even on the web in blog posts,
4343
articles, and such.
4444

4545
Submit Feedback
4646
~~~~~~~~~~~~~~~
4747

48-
The best way to send feedback is to file an issue at https://github.com/akeshavan/preafq/issues.
48+
The best way to send feedback is to file an issue at https://github.com/nipy/dmriprep/issues.
4949

5050
If you are proposing a feature:
5151

@@ -57,17 +57,17 @@ If you are proposing a feature:
5757
Get Started!
5858
------------
5959

60-
Ready to contribute? Here's how to set up `preafq` for local development.
60+
Ready to contribute? Here's how to set up `dmriprep` for local development.
6161

62-
1. Fork the `preafq` repo on GitHub.
62+
1. Fork the `dmriprep` repo on GitHub.
6363
2. Clone your fork locally::
6464

65-
$ git clone [email protected]:your_name_here/preafq.git
65+
$ git clone [email protected]:your_name_here/dmriprep.git
6666

6767
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
6868

69-
$ mkvirtualenv preafq
70-
$ cd preafq/
69+
$ mkvirtualenv dmriprep
70+
$ cd dmriprep/
7171
$ python setup.py develop
7272

7373
4. Create a branch for local development::
@@ -79,7 +79,7 @@ Ready to contribute? Here's how to set up `preafq` for local development.
7979
5. When you're done making changes, check that your changes pass flake8 and the
8080
tests, including testing other Python versions with tox::
8181

82-
$ flake8 preafq tests
82+
$ flake8 dmriprep tests
8383
$ python setup.py test or py.test
8484
$ tox
8585

@@ -103,15 +103,15 @@ Before you submit a pull request, check that it meets these guidelines:
103103
your new functionality into a function with a docstring, and add the
104104
feature to the list in README.rst.
105105
3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check
106-
https://travis-ci.org/akeshavan/preafq/pull_requests
106+
https://travis-ci.org/nipy/dmriprep/pull_requests
107107
and make sure that the tests pass for all supported Python versions.
108108

109109
Tips
110110
----
111111

112112
To run a subset of tests::
113113

114-
$ py.test tests.test_preafq
114+
$ py.test tests.test_dmriprep
115115

116116

117117
Deploying

Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ clean-test: ## remove test and coverage artifacts
5151
rm -fr .pytest_cache
5252

5353
lint: ## check style with flake8
54-
flake8 preafq tests
54+
flake8 dmriprep tests
5555

5656
test: ## run tests quickly with the default Python
5757
py.test
@@ -60,15 +60,15 @@ test-all: ## run tests on every Python version with tox
6060
tox
6161

6262
coverage: ## check code coverage quickly with the default Python
63-
coverage run --source preafq -m pytest
63+
coverage run --source dmriprep -m pytest
6464
coverage report -m
6565
coverage html
6666
$(BROWSER) htmlcov/index.html
6767

6868
docs: ## generate Sphinx HTML documentation, including API docs
69-
rm -f docs/preafq.rst
69+
rm -f docs/dmriprep.rst
7070
rm -f docs/modules.rst
71-
sphinx-apidoc -o docs/ preafq
71+
sphinx-apidoc -o docs/ dmriprep
7272
$(MAKE) -C docs clean
7373
$(MAKE) -C docs html
7474
$(BROWSER) docs/_build/html/index.html

README.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
======
2-
preAFQ
2+
dmriprep
33
======
44

55

6-
.. image:: https://img.shields.io/pypi/v/preafq.svg
7-
:target: https://pypi.python.org/pypi/preafq
6+
.. image:: https://img.shields.io/pypi/v/dmriprep.svg
7+
:target: https://pypi.python.org/pypi/dmriprep
88

9-
.. image:: https://img.shields.io/travis/akeshavan/preafq.svg
10-
:target: https://travis-ci.org/akeshavan/preafq
9+
.. image:: https://img.shields.io/travis/akeshavan/dmriprep.svg
10+
:target: https://travis-ci.org/akeshavan/dmriprep
1111

12-
.. image:: https://readthedocs.org/projects/preafq/badge/?version=latest
13-
:target: https://preafq.readthedocs.io/en/latest/?badge=latest
12+
.. image:: https://readthedocs.org/projects/dmriprep/badge/?version=latest
13+
:target: https://dmriprep.readthedocs.io/en/latest/?badge=latest
1414
:alt: Documentation Status
1515

1616

@@ -20,7 +20,7 @@ Preprocessing of neuroimaging data in preparation for AFQ analysis
2020

2121

2222
* Free software: BSD license
23-
* Documentation: https://preafq.readthedocs.io.
23+
* Documentation: https://dmriprep.readthedocs.io.
2424

2525

2626
Features
@@ -32,10 +32,10 @@ Features
3232
Contributing
3333
------------
3434

35-
We love contributions! preAFQ is open source, built on open source,
35+
We love contributions! dmriprep is open source, built on open source,
3636
and we'd love to have you hang out in our community.
3737

38-
We have developed some `guidelines`_ for contributing to preAFQ.
38+
We have developed some `guidelines`_ for contributing to dmriprep.
3939

4040
**Imposter syndrome disclaimer**: We want your help. No, really.
4141

preafq/__init__.py renamed to dmriprep/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22

3-
"""Top-level package for preAFQ."""
3+
"""Top-level package for dmriprep."""
44

55
__author__ = """Anisha Keshavan"""
66
__email__ = '[email protected]'
@@ -10,7 +10,7 @@
1010
import logging
1111
import os
1212

13-
from .preafq import upload_to_s3 # noqa
13+
from .dmriprep import upload_to_s3 # noqa
1414
from . import fetch_bids_s3 # noqa
1515

1616

@@ -48,7 +48,7 @@
4848

4949
# add the handlers to the logger
5050
module_logger.addHandler(handler)
51-
module_logger.info('Started new preAFQ session')
51+
module_logger.info('Started new dmriprep session')
5252

5353
# Reduce verbosity of the boto logs
5454
logging.getLogger('boto').setLevel(logging.WARNING)

preafq/base.py renamed to dmriprep/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22

3-
"""Base datatypes for preafq"""
3+
"""Base datatypes for dmriprep"""
44

55
from collections import namedtuple
66

preafq/cli.py renamed to dmriprep/cli.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# -*- coding: utf-8 -*-
22

3-
"""Console script for preafq."""
3+
"""Console script for dmriprep."""
44
import sys
55
import click
66

77

88
@click.command()
99
def main(args=None):
10-
"""Console script for preafq."""
10+
"""Console script for dmriprep."""
1111
click.echo("Replace this message by putting your code into "
12-
"preafq.cli.main")
12+
"dmriprep.cli.main")
1313
click.echo("See click documentation at http://click.pocoo.org/")
1414
return 0
1515

preafq/preafq.py renamed to dmriprep/dmriprep.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
import nibabel as nib
1212

1313
from . import fetch_bids_s3 as fetch
14-
from .run_1 import run_preAFQ
14+
from .run_1 import run_dmriprep
1515

1616

1717
mod_logger = logging.getLogger(__name__)
@@ -47,7 +47,7 @@ def upload_to_s3(output_files, outdir, bucket, prefix, site, session, subject):
4747
----------
4848
output_files : list
4949
Output files to transfer to S3. Assume that the user has passed in
50-
relative paths that are appropriate to fill in after the 'preAFQ'
50+
relative paths that are appropriate to fill in after the 'dmriprep'
5151
directory.
5252
5353
outdir : string
@@ -78,7 +78,7 @@ def upload_to_s3(output_files, outdir, bucket, prefix, site, session, subject):
7878
def filename2s3key(filename):
7979
return '/'.join([
8080
prefix, site, subject, session,
81-
'derivatives', 'preAFQ',
81+
'derivatives', 'dmriprep',
8282
filename
8383
])
8484

@@ -106,7 +106,7 @@ def pre_afq_individual(input_s3_keys, s3_prefix, out_bucket,
106106
scratch_dir = op.join(workdir, 'scratch')
107107
out_dir = op.join(workdir, 'output')
108108

109-
run_preAFQ(
109+
run_dmriprep(
110110
dwi_file=input_files.files['dwi'][0],
111111
dwi_file_AP=input_files.files['epi_ap'][0],
112112
dwi_file_PA=input_files.files['epi_pa'][0],

0 commit comments

Comments
 (0)