Skip to content

Commit 9588b4d

Browse files
nipreps-botoesteban
authored andcommitted
enh: rename all instances of "eddymotion"
``` git ls-files -z | xargs -0 sed -i 's/eddymotion/nifreeze/g' git mv src/eddymotion src/nifreeze git mv docs/_static/eddymotion-flowchart.svg docs/_static/nifreeze-flowchart.svg ```
1 parent 3a6088e commit 9588b4d

Some content is hidden

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

51 files changed

+202
-202
lines changed

.dockerignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ build/**/*
88
build
99
dist/**/*
1010
dist
11-
src/eddymotion.egg-info/**/*
12-
src/eddymotion.egg-info
11+
src/nifreeze.egg-info/**/*
12+
src/nifreeze.egg-info
1313
.eggs/**/*
1414
.eggs
1515

.github/workflows/pythonpackage.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
pip install -U build hatch pip twine
4242
4343
python -m build -s -w
44-
python -m twine check dist/eddymotion-*
44+
python -m twine check dist/nifreeze-*
4545
4646
mv dist /tmp/package
4747
@@ -60,7 +60,7 @@ jobs:
6060
source /tmp/pip/bin/activate
6161
pip install -U pip
6262
python -m pip install .
63-
INSTALLED_VERSION=$(python -c 'import eddymotion as em; print(em.__version__, end="")')
63+
INSTALLED_VERSION=$(python -c 'import nifreeze as em; print(em.__version__, end="")')
6464
echo "VERSION: \"${THISVERSION}\""
6565
echo "INSTALLED: \"${INSTALLED_VERSION}\""
6666
test "${INSTALLED_VERSION}" = "${THISVERSION}"
@@ -70,8 +70,8 @@ jobs:
7070
python -m venv /tmp/install_sdist
7171
source /tmp/install_sdist/bin/activate
7272
pip install -U pip
73-
python -m pip install /tmp/package/eddymotion*.tar.gz
74-
INSTALLED_VERSION=$(python -c 'import eddymotion as em; print(em.__version__, end="")')
73+
python -m pip install /tmp/package/nifreeze*.tar.gz
74+
INSTALLED_VERSION=$(python -c 'import nifreeze as em; print(em.__version__, end="")')
7575
echo "VERSION: \"${THISVERSION}\""
7676
echo "INSTALLED: \"${INSTALLED_VERSION}\""
7777
test "${INSTALLED_VERSION}" = "${THISVERSION}"
@@ -81,7 +81,7 @@ jobs:
8181
python -m venv /tmp/install_wheel
8282
source /tmp/install_wheel/bin/activate
8383
pip install -U pip
84-
python -m pip install /tmp/package/eddymotion*.whl
85-
INSTALLED_VERSION=$(python -c 'import eddymotion as em; print(em.__version__, end="")')
84+
python -m pip install /tmp/package/nifreeze*.whl
85+
INSTALLED_VERSION=$(python -c 'import nifreeze as em; print(em.__version__, end="")')
8686
echo "INSTALLED: \"${INSTALLED_VERSION}\""
8787
test "${INSTALLED_VERSION}" = "${THISVERSION}"

.github/workflows/test.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ defaults:
1919
# Force tox and pytest to use color
2020
env:
2121
FORCE_COLOR: true
22-
TEST_DATA_HOME: /home/runner/eddymotion-tests/
22+
TEST_DATA_HOME: /home/runner/nifreeze-tests/
2323
ITK_GLOBAL_DEFAULT_NUMBER_OF_THREADS: 4
2424
ANTSPATH: /usr/share/miniconda/bin/
2525

@@ -54,20 +54,20 @@ jobs:
5454
datalad wtf
5555
- uses: actions/cache/restore@v4
5656
with:
57-
path: /home/runner/eddymotion-tests/
57+
path: /home/runner/nifreeze-tests/
5858
key: data-v0
5959
- name: Get test data with DataLad
6060
run: |
6161
if [[ ! -d "${TEST_DATA_HOME}" ]]; then
62-
datalad install -rg --source=https://gin.g-node.org/nipreps-data/tests-eddymotion.git ${TEST_DATA_HOME}
62+
datalad install -rg --source=https://gin.g-node.org/nipreps-data/tests-nifreeze.git ${TEST_DATA_HOME}
6363
else
6464
cd ${TEST_DATA_HOME}
6565
datalad update --merge -r .
6666
datalad get -r -J4 *
6767
fi
6868
- uses: actions/cache/save@v4
6969
with:
70-
path: /home/runner/eddymotion-tests/
70+
path: /home/runner/nifreeze-tests/
7171
key: data-v0
7272
- name: Install tox
7373
run: |

.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# setuptools-scm
2-
eddymotion/_version.py
2+
nifreeze/_version.py
33

44
# Byte-compiled / optimized / DLL files
55
__pycache__/
@@ -115,4 +115,4 @@ ENV/
115115
kubernetes/jobs/
116116

117117
# Version files
118-
src/eddymotion/_version.py
118+
src/nifreeze/_version.py

.zenodo.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"scheme": "doi"
2121
}
2222
],
23-
"title": "eddymotion: model-based estimation of head-motion and eddy-current distortions",
23+
"title": "nifreeze: model-based estimation of head-motion and eddy-current distortions",
2424
"upload_type": "software",
2525
"creators": [
2626
{

CHANGES.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A new minor release with fixes such as setting random seeds and enhancing parall
2323
* ENH: Drop support for Python 3.8 and 3.9 (#158)
2424
* ENH: Remove unused `tmp_path` parameter from test (#162)
2525
* ENH: Outsource leave-one-out splitter so it can be used across data types (#98)
26-
* ENH: Simplify `eddymotion.estimator.EddyMotionEstimator.fit` (#149)
26+
* ENH: Simplify `nifreeze.estimator.EddyMotionEstimator.fit` (#149)
2727
* ENH: Refactor code linter and formatter dependencies (#144)
2828
* ENH: Use NumPy's `Generator` class as a replacement for `RandomState` (#141)
2929
* ENH: Define instance attributes in ``__init__`` method (#133)

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Contributing to *eddymotion*
1+
# Contributing to *nifreeze*
22

3-
*eddymotion* is a project of the [*NiPreps* Community, which specifies the contributing guidelines](https://www.nipreps.org/community/).
3+
*nifreeze* is a project of the [*NiPreps* Community, which specifies the contributing guidelines](https://www.nipreps.org/community/).

NOTICE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
eddymotion
1+
nifreeze
22
Copyright 2021 The NiPreps Developers.
33

44
This product includes software developed by

README.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@ Estimating head-motion and deformations derived from eddy-currents in diffusion
77
:alt: DOI
88

99
.. image:: https://img.shields.io/badge/License-Apache_2.0-blue.svg
10-
:target: https://github.com/nipreps/eddymotion/blob/main/LICENSE
10+
:target: https://github.com/nipreps/nifreeze/blob/main/LICENSE
1111
:alt: License
1212

13-
.. image:: https://img.shields.io/pypi/v/eddymotion.svg
14-
:target: https://pypi.python.org/pypi/eddymotion/
13+
.. image:: https://img.shields.io/pypi/v/nifreeze.svg
14+
:target: https://pypi.python.org/pypi/nifreeze/
1515
:alt: Latest Version
1616

17-
.. image:: https://github.com/nipreps/eddymotion/actions/workflows/test.yml/badge.svg
18-
:target: https://github.com/nipreps/eddymotion/actions/workflows/test.yml
17+
.. image:: https://github.com/nipreps/nifreeze/actions/workflows/test.yml/badge.svg
18+
:target: https://github.com/nipreps/nifreeze/actions/workflows/test.yml
1919
:alt: Testing
2020

21-
.. image:: https://github.com/nipreps/eddymotion/actions/workflows/pages/pages-build-deployment/badge.svg
22-
:target: https://www.nipreps.org/eddymotion/main/index.html
21+
.. image:: https://github.com/nipreps/nifreeze/actions/workflows/pages/pages-build-deployment/badge.svg
22+
:target: https://www.nipreps.org/nifreeze/main/index.html
2323
:alt: Documentation
2424

25-
.. image:: https://github.com/nipreps/eddymotion/actions/workflows/pythonpackage.yml/badge.svg
26-
:target: https://github.com/nipreps/eddymotion/actions/workflows/pythonpackage.yml
25+
.. image:: https://github.com/nipreps/nifreeze/actions/workflows/pythonpackage.yml/badge.svg
26+
:target: https://github.com/nipreps/nifreeze/actions/workflows/pythonpackage.yml
2727
:alt: Python package
2828

2929
Retrospective estimation of head-motion between diffusion-weighted images (DWI) acquired within
@@ -49,8 +49,8 @@ the work of ``eddy`` and *SHORELine*, while generalizing these methods to multip
4949

5050
.. BEGIN FLOWCHART
5151
52-
.. image:: https://raw.githubusercontent.com/nipreps/eddymotion/507fc9bab86696d5330fd6a86c3870968243aea8/docs/_static/eddymotion-flowchart.svg
53-
:alt: The eddymotion flowchart
52+
.. image:: https://raw.githubusercontent.com/nipreps/nifreeze/507fc9bab86696d5330fd6a86c3870968243aea8/docs/_static/nifreeze-flowchart.svg
53+
:alt: The nifreeze flowchart
5454

5555
.. END FLOWCHART
5656

docs/Makefile

+4-4
Original file line numberDiff line numberDiff line change
@@ -97,17 +97,17 @@ qthelp:
9797
@echo
9898
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
9999
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
100-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/eddymotion.qhcp"
100+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nifreeze.qhcp"
101101
@echo "To view the help file:"
102-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/eddymotion.qhc"
102+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nifreeze.qhc"
103103

104104
devhelp:
105105
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
106106
@echo
107107
@echo "Build finished."
108108
@echo "To view the help file:"
109-
@echo "# mkdir -p $$HOME/.local/share/devhelp/eddymotion"
110-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/eddymotion"
109+
@echo "# mkdir -p $$HOME/.local/share/devhelp/nifreeze"
110+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/nifreeze"
111111
@echo "# devhelp"
112112

113113
epub:
File renamed without changes.

docs/conf.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
from packaging.version import Version
1111

12-
from eddymotion import __copyright__, __packagename__, __version__
12+
from nifreeze import __copyright__, __packagename__, __version__
1313

1414
# -- Path setup --------------------------------------------------------------
1515
# If extensions (or modules to document with autodoc) are in another directory,
@@ -104,7 +104,7 @@
104104
"_build",
105105
"Thumbs.db",
106106
".DS_Store",
107-
"api/eddymotion.rst",
107+
"api/nifreeze.rst",
108108
]
109109

110110
# The name of the Pygments (syntax highlighting) style to use.
@@ -149,7 +149,7 @@
149149
# -- Options for HTMLHelp output ---------------------------------------------
150150

151151
# Output file base name for HTML help builder.
152-
htmlhelp_basename = "eddymotiondoc"
152+
htmlhelp_basename = "nifreezedoc"
153153

154154

155155
# -- Options for LaTeX output ------------------------------------------------
@@ -228,7 +228,7 @@
228228

229229
# -- Extension configuration -------------------------------------------------
230230

231-
apidoc_module_dir = "../src/eddymotion"
231+
apidoc_module_dir = "../src/nifreeze"
232232
apidoc_output_dir = "api"
233233
apidoc_excluded_paths = ["conftest.py", "*/tests/*", "tests/*", "config/*"]
234234
apidoc_separate_modules = True

docs/developers.rst

+16-16
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ Before delving into the code, please make sure you have read all the guidelines
77

88
Documentation
99
-------------
10-
Documentation sources are found under the ``docs/`` folder, and builds are archived in the `gh-pages <https://github.com/nipreps/eddymotion/tree/gh-pages>`__ branch of the repository.
11-
With GitHub Pages, the documentation is posted under https://www.nipreps.org/eddymotion.
10+
Documentation sources are found under the ``docs/`` folder, and builds are archived in the `gh-pages <https://github.com/nipreps/nifreeze/tree/gh-pages>`__ branch of the repository.
11+
With GitHub Pages, the documentation is posted under https://www.nipreps.org/nifreeze.
1212
We maintain versioned documentation, by storing git tags under ``<major>.<minor>/`` folders, i.e., we do not archive every patch release, but only every minor release.
1313
In other words, folder ``0.1/`` of the documentation tree contains the documents for the latest release within the *0.1.x* series.
1414
With every commit (or merge commit) to ``main``, the *development* version of the documentation under the folder ``main/`` is updated too.
15-
The ``gh-pages`` branch is automatically maintained with `a GitHub Action <https://github.com/nipreps/eddymotion/blob/main/.github/workflows/docs-build-update.yml>`__.
15+
The ``gh-pages`` branch is automatically maintained with `a GitHub Action <https://github.com/nipreps/nifreeze/blob/main/.github/workflows/docs-build-update.yml>`__.
1616
Please, do not commit manually to ``gh-pages``.
1717

1818
To build the documentation locally, you first need to make sure that ``setuptools_scm[toml] >= 6.2`` is installed in your environment and then::
1919

20-
$ cd <eddymotion-repository>/
21-
$ python -m setuptools_scm # This will generate ``src/eddymotion/_version.py``
20+
$ cd <nifreeze-repository>/
21+
$ python -m setuptools_scm # This will generate ``src/nifreeze/_version.py``
2222
$ make -C docs/ html
2323

2424
Library API (application program interface)
@@ -28,14 +28,14 @@ Information on specific functions, classes, and methods.
2828
.. toctree::
2929
:glob:
3030

31-
api/eddymotion.cli
32-
api/eddymotion.data
33-
api/eddymotion.data.dmri
34-
api/eddymotion.estimator
35-
api/eddymotion.exceptions
36-
api/eddymotion.math
37-
api/eddymotion.model
38-
api/eddymotion.registration
39-
api/eddymotion.testing
40-
api/eddymotion.utils
41-
api/eddymotion.viz
31+
api/nifreeze.cli
32+
api/nifreeze.data
33+
api/nifreeze.data.dmri
34+
api/nifreeze.estimator
35+
api/nifreeze.exceptions
36+
api/nifreeze.math
37+
api/nifreeze.model
38+
api/nifreeze.registration
39+
api/nifreeze.testing
40+
api/nifreeze.utils
41+
api/nifreeze.viz

docs/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
.. include:: ../README.rst
55
:start-after: END FLOWCHART
66

7-
.. image:: _static/eddymotion-flowchart.svg
8-
:alt: The eddymotion flowchart
7+
.. image:: _static/nifreeze-flowchart.svg
8+
:alt: The nifreeze flowchart
99

1010
Contents
1111
--------

docs/installation.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33

44
Installation
55
============
6-
Make sure all of *eddymotion*' `External Dependencies`_ are installed.
6+
Make sure all of *nifreeze*' `External Dependencies`_ are installed.
77

88
On a functional Python 3.10 (or above) environment with ``pip`` installed,
9-
*eddymotion* can be installed using the habitual command ::
9+
*nifreeze* can be installed using the habitual command ::
1010

11-
$ python -m pip install eddymotion
11+
$ python -m pip install nifreeze
1212

1313
Check your installation with the following command line ::
1414

15-
$ python -c "from eddymotion import __version__; print(__version__)"
15+
$ python -c "from nifreeze import __version__; print(__version__)"
1616

1717

1818
External Dependencies
1919
---------------------
20-
*eddymotion* requires DIPY_, and ANTs_.
20+
*nifreeze* requires DIPY_, and ANTs_.

0 commit comments

Comments
 (0)