@@ -7,19 +7,18 @@ Interface Specifications
7
7
Before you start
8
8
----------------
9
9
10
- Nipype is a young project maintained by an enthusiastic group of developers.
11
- Even though the documentation might be sparse or cryptic at times we strongly
12
- encourage you to contact us on the official nipype developers mailing list in
13
- case of any troubles: nipy-devel@neuroimaging.scipy.org (we are sharing a
14
- mailing list with the nipy community therefore please add ``[nipype] `` to the
15
- messsage title).
10
+ Nipype is maintained by an enthusiastic group of developers, and we're excited to have you join!
11
+ In case of trouble, we encourage you to post on `NeuroStars <https://neurostars.org >`_ with the `nipype ` tag.
12
+ NeuroStars.org is a platform similar to StackOverflow but dedicated to neuroinformatics.
13
+ You can also post on the nipype developers mailing list: http://mail.python.org/mailman/listinfo/neuroimaging.
14
+ We are sharing a mailing list with the nipy community therefore please add ``[nipype] `` to the message title.
16
15
17
16
18
17
Overview
19
18
--------
20
19
21
- We're using the `Enthought Traits
22
- <http://code .enthought.com/projects/ traits/> `_ package for all of our
20
+ We're using the `Traits, formerly known as Enthought Traits
21
+ <http://docs .enthought.com/traits/traits_user_manual/intro.html > `_ package for all of our
23
22
inputs and outputs. Traits allows us to validate user inputs and
24
23
provides a mechanism to handle all the *special cases * in a simple and
25
24
concise way though metadata. With the metadata, each input/output can
@@ -37,36 +36,33 @@ Specification, you only need to learn a few of the basics of Traits.
37
36
Here are a few starting points in the documentation:
38
37
39
38
* What are Traits? The `Introduction in the User Manual
40
- <http://code .enthought.com/projects/ traits/docs/html /traits_user_manual/intro.html> `_
39
+ <http://docs .enthought.com/traits/traits_user_manual/intro.html> `_
41
40
gives a brief description of the functionality traits provides.
42
41
43
42
* Traits and metadata. The `second section of the User Manual
44
- <http://code .enthought.com/projects/ traits/docs/html /traits_user_manual/defining.html> `_
43
+ <http://docs .enthought.com/traits/traits_user_manual/defining.html> `_
45
44
gives more details on traits and how to use them. Plus there a
46
45
section describing metadata, including the metadata all traits have.
47
46
48
47
* If your interested in more of a *big picture * overview, `Gael wrote
49
48
a good tutorial
50
- <http://code .enthought.com/projects/traits/docs/html /tutorials/traits_ui_scientific_app.html> `_
49
+ <http://docs .enthought.com/traitsui /tutorials/traits_ui_scientific_app.html> `_
51
50
that shows how to write a scientific application using traits for
52
51
the benefit of the generated UI components. (For now, Nipype is not
53
52
taking advantage of the generated UI feature of traits.)
54
53
55
54
Traits version
56
55
^^^^^^^^^^^^^^
57
56
58
- We're using Traits version 3.x which can be install as part of `EPD
59
- <http://enthought.com/products/epd.php> `_ or from `pypi
60
- <http://pypi.python.org/pypi/Traits/3.3.0> `_
57
+ We're using Traits version 4.x which can be installed from `pypi
58
+ <https://pypi.python.org/pypi/traits> `_
61
59
62
60
More documentation
63
61
^^^^^^^^^^^^^^^^^^
64
62
65
63
Not everything is documented in the User Manual, in those cases the
66
- `enthought-dev mailing list
67
- <https://mail.enthought.com/mailman/listinfo/enthought-dev> `_ or the
68
- `API docs
69
- <http://code.enthought.com/projects/files/ETS32_API/enthought.traits.html> `_
64
+ the `API docs
65
+ <http://docs.enthought.com/traits/traits_api_reference/index.html> `_
70
66
is your next place to look.
71
67
72
68
Nipype Interface Specifications
@@ -80,13 +76,12 @@ the interfaces. For example, Bet has these specs:
80
76
- BETOutputSpec
81
77
82
78
Each of these Specs are classes, derived from a base TraitedSpec class
83
- (more on these below). The InputSpec consists of attributes which
79
+ (more on these below). The InputSpec consists of attributes which
84
80
correspond to different parameters for the tool they wrap/interface.
85
81
In the case of a command-line tool like Bet, the InputSpec attributes
86
82
correspond to the different command-line parameters that can be passed
87
- to Bet. If you are familiar with the Nipype 0.2 code-base, these
88
- attributes are the same as the keys in the opt_map dictionaries. When
89
- an interfaces class is instantiated, the InputSpec is bound to the
83
+ to Bet.
84
+ When an interfaces class is instantiated, the InputSpec is bound to the
90
85
``inputs `` attribute of that object. Below is an example of how the
91
86
``inputs `` appear to a user for Bet::
92
87
0 commit comments