Skip to content

WIP: Move nipype commands to a group command #1608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Oct 9, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
4237c65
wip: move first nipype commands to a group command
alexsavio Sep 8, 2016
578970e
wip: add "nipype run" command
alexsavio Sep 9, 2016
b2c9867
remove unused function in scripts/instance
alexsavio Sep 9, 2016
8207421
wip: add to_boutiques command
alexsavio Sep 9, 2016
64317f4
add convert subgroup for boutiques
alexsavio Sep 12, 2016
a40ee7e
remove unused function
alexsavio Sep 12, 2016
d448c7f
fix argument name for crash CLI. add callbacks
alexsavio Sep 13, 2016
029ddda
fix CLI for print_usage commands fail print_help
alexsavio Sep 16, 2016
d1cb857
remove bin/ folder, replaced by click
alexsavio Sep 19, 2016
44d78af
remove unused import
alexsavio Sep 19, 2016
430761c
Merge remote-tracking branch 'nipype/master'
alexsavio Oct 6, 2016
f17d8e2
add click to info.py REQUIRES
alexsavio Oct 6, 2016
3d0c790
fix missing import in cli.py
alexsavio Oct 6, 2016
a6697a8
fix docstring in scripts.instance
alexsavio Oct 6, 2016
6689c1d
Merge remote-tracking branch 'upstream/master' into nipypeclick
satra Oct 7, 2016
8f4e335
add script installer
satra Oct 7, 2016
47e0291
Merge pull request #11 from satra/nipypeclick
satra Oct 7, 2016
d022077
fix interface doc builder skip patterns
satra Oct 7, 2016
e82fc40
Merge pull request #12 from satra/nipypeclick
satra Oct 7, 2016
2483b7a
doc+fix: do not generate api from scripts directory
satra Oct 7, 2016
1c1ef24
Merge pull request #13 from satra/nipypeclick
satra Oct 7, 2016
083e31b
doc: update cli related docs
satra Oct 8, 2016
3e650d4
Merge pull request #14 from satra/nipypeclick
satra Oct 8, 2016
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions bin/nipype2boutiques

This file was deleted.

8 changes: 0 additions & 8 deletions bin/nipype_cmd

This file was deleted.

82 changes: 0 additions & 82 deletions bin/nipype_crash_search

This file was deleted.

85 changes: 0 additions & 85 deletions bin/nipype_display_crash

This file was deleted.

36 changes: 0 additions & 36 deletions bin/nipype_display_pklz

This file was deleted.

24 changes: 24 additions & 0 deletions doc/users/cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _cli:

=============================
Nipype Command Line Interface
=============================

The Nipype Command Line Interface allows a variety of operations::

$ nipypecli
Usage: nipypecli [OPTIONS] COMMAND [ARGS]...

Options:
-h, --help Show this message and exit.

Commands:
convert Export nipype interfaces to other formats.
crash Display Nipype crash files.
run Run a Nipype Interface.
search Search for tracebacks content.
show Print the content of Nipype node .pklz file.

These have replaced previous nipype command line tools such as
`nipype_display_crash`, `nipype_crash_search`, `nipype2boutiques`,
`nipype_cmd` and `nipype_display_pklz`.
11 changes: 7 additions & 4 deletions doc/users/debug.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ performance issues.
from nipype import config
config.enable_debug_mode()

as the first import of your nipype script.
as the first import of your nipype script. To enable debug logging use::

from nipype import logging
logging.update_logging(config)

.. note::

Expand All @@ -39,10 +42,10 @@ performance issues.
node to fail without generating a crash file in the crashdump directory. In
such cases, it will store a crash file in the `batch` directory.

#. All Nipype crashfiles can be inspected with the `nipype_display_crash`
#. All Nipype crashfiles can be inspected with the `nipypecli crash`
utility.

#. The `nipype_crash_search` command allows you to search for regular expressions
#. The `nipypecli search` command allows you to search for regular expressions
in the tracebacks of the Nipype crashfiles within a log folder.

#. Nipype determines the hash of the input state of a node. If any input
Expand All @@ -66,6 +69,6 @@ performance issues.
PBS/LSF/SGE/Condor plugins in such cases the workflow may crash because it
cannot retrieve the node result. Setting the `job_finished_timeout` can help::

workflow.config['execution']['job_finished_timeout'] = 65
workflow.config['execution']['job_finished_timeout'] = 65

.. include:: ../links_names.txt
2 changes: 1 addition & 1 deletion doc/users/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
plugins
config_file
debug

cli

.. toctree::
:maxdepth: 1
Expand Down
2 changes: 2 additions & 0 deletions nipype/info.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ def get_nipype_gitversion():
FUTURE_MIN_VERSION = '0.15.2'
SIMPLEJSON_MIN_VERSION = '3.8.0'
PROV_MIN_VERSION = '1.4.0'
CLICK_MIN_VERSION = '6.6.0'

NAME = 'nipype'
MAINTAINER = 'nipype developers'
Expand Down Expand Up @@ -141,6 +142,7 @@ def get_nipype_gitversion():
'future>=%s' % FUTURE_MIN_VERSION,
'simplejson>=%s' % SIMPLEJSON_MIN_VERSION,
'prov>=%s' % PROV_MIN_VERSION,
'click>=%s' % CLICK_MIN_VERSION,
'xvfbwrapper',
'funcsigs'
]
Expand Down
1 change: 1 addition & 0 deletions nipype/scripts/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Loading