Skip to content

Commit

Permalink
Remove elements that don't appear necessary.
Browse files Browse the repository at this point in the history
  • Loading branch information
tsalo committed Dec 1, 2024
1 parent 73ac4a3 commit c8866d0
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 52 deletions.
5 changes: 0 additions & 5 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,5 +0,0 @@
[submodule "tests/data/ds000005-fmriprep"]
path = tests/data/ds000005-fmriprep
url = https://gin.g-node.org/nipreps-data/ds000005-fmriprep
datalad-id = 92e566e4-1c80-434e-a4d7-5bf9fb483d76
datalad-url = https://gin.g-node.org/nipreps-data/ds000005-fmriprep
2 changes: 1 addition & 1 deletion .zenodo.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
],
"creators": [
{
"affiliation": "Department of Psychology, Florida International University",
"affiliation": "University of Pennsylvania",
"name": "Salo, Taylor",
"orcid": "0000-0001-9813-3167"
},
Expand Down
22 changes: 22 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ Here are a few of the key features:
In this case, the fMRIPost-AROMA workflow will pull a transform from MNI152NLin2009cAsym
to MNI152NLin6Asym from TemplateFlow and apply it,
along with the boldref-to-MNI152NLin2009cAsym transform, to the boldref-space derivatives.
- fMRIPrep with ``--level full`` and raw BOLD data.
In this case, the fMRIPost workflow will apply minimal preprocessing steps internally
to generate the required derivatives.
This will rarely be used, but may be useful for fMRIPost workflows that require raw data,
like fMRIPost-phase.

.. warning::

Expand All @@ -40,3 +45,20 @@ Here are a few of the key features:

4. General NiPreps infrastructure for running a BIDS App, such as a config file,
a command-line interface, and tools to generate HTML reports.


*****
Usage
*****

If you use this template to create a new fMRIPost workflow, you will need to:

1. Replace all instances of ``fmripost_template`` with the name of your new workflow.
2. Replace all instances of ``fMRIPost-template`` with the name of your new workflow.
3. Modify the workflows and interfaces to apply your desired processing steps.
4. Update the documentation to reflect the new workflow.

Please also include something like the following in your boilerplate:

> Data were postprocessed using *fMRIPost-<name>*,
> which is based on *fMRIPost-template* ([cite fMRIPost-template version and DOI here]).
9 changes: 0 additions & 9 deletions src/fmripost_template/__main__.py

This file was deleted.

26 changes: 0 additions & 26 deletions src/fmripost_template/_version.pyi

This file was deleted.

45 changes: 34 additions & 11 deletions src/fmripost_template/cli/__init__.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,36 @@
# SPDX-FileCopyrightText: 2023-present Chris Markiewicz <[email protected]>
# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
# vi: set ft=python sts=4 ts=4 sw=4 et:
#
# SPDX-License-Identifier: Apache-2.0
import click

from .. import __version__

# Copyright 2024 The NiPreps Developers <[email protected]>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# We support and encourage derived works from this project, please read
# about our expectations at
#
# https://www.nipreps.org/community/licensing/
#
"""Command-line interface modules for fMRIPost-template."""
from . import (
parser,
run,
version,
workflow,
)

@click.group(context_settings={'help_option_names': ['-h', '--help']}, invoke_without_command=True)
@click.version_option(version=__version__, prog_name='fmripost-template')
@click.pass_context
def fmripost_template(ctx: click.Context):
click.echo('Hello world!')
__all__ = [
'parser',
'run',
'version',
'workflow',
]

0 comments on commit c8866d0

Please sign in to comment.