Skip to content

Commit c9e5d37

Browse files
committed
DOC - updated data doc to reflect move of data packaging to github
1 parent 440e361 commit c9e5d37

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

doc/source/data_pkg_design.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ NIPY-related packages such as ``pbrain``). The ``data`` subdirectory of
162162
``config.ini`` file, that has at least an entry like this::
163163

164164
[DEFAULT]
165-
version = 0.1
165+
version = 0.2
166166

167167
giving the version of the data package.
168168

@@ -189,9 +189,8 @@ For the example above this will result in these subdirectories::
189189
because ``nipy`` is both the project, and the package to which the data
190190
relates.
191191

192-
If you install to a particular location, you will need to add that location to
193-
the output of ``nipy.data.get_data_path()`` using one of the mechanisms above,
194-
for example, in your system configuration::
192+
If you install to a particular location, you will need to add that
193+
location to the output of ``nipy.data.get_data_path()`` using one of the mechanisms above, for example, in your system configuration::
195194

196195
export NIPY_DATA_PATH=/my/prefix/share/nipy
197196

@@ -215,8 +214,8 @@ contents::
215214
Current implementation
216215
``````````````````````
217216

218-
This section describes how we (the nibabel package) implement data packages
219-
at the moment.
217+
This section describes how we (the nipy community) implement data packages at
218+
the moment.
220219

221220
The data in the data packages will not usually be under source control. This is
222221
because images don't compress very well, and any change in the data will result
@@ -226,7 +225,7 @@ the data files aren't going to change, then a repository could work OK.
226225
The data packages will be available at a central release location. For
227226
now this will be: http://nipy.sourceforge.net/data-packages/ .
228227

229-
A package, such as ``nipy-templates-0.1.tar.gz`` will have the following
228+
A package, such as ``nipy-templates-0.2.tar.gz`` will have the following
230229
sort of structure::
231230

232231

@@ -236,6 +235,8 @@ sort of structure::
236235
|-- MANIFEST.in
237236
`-- templates
238237
|-- ICBM152
238+
| |-- 1mm
239+
| | `-- T1_brain.nii.gz
239240
| `-- 2mm
240241
| `-- T1.nii.gz
241242
|-- colin27
@@ -246,14 +247,14 @@ sort of structure::
246247

247248
There should be only one ``nipy/packagename`` directory delivered by a
248249
particular package. For example, this package installs
249-
``nipy/templates``, but does not contain ``nipy/data``.
250+
``nipy/templates``, but does not contain ``nipy/data``.
250251

251252
Making a new package tarball is simply:
252253

253254
#. Downloading and unpacking e.g ``nipy-templates-0.1.tar.gz`` to form
254255
the directory structure above.
255256
#. Making any changes to the directory
256-
#. Running ``setup.py sdist`` to recreate the package.
257+
#. Running ``setup.py sdist`` to recreate the package.
257258

258259
The process of making a release should be:
259260

@@ -264,8 +265,7 @@ The process of making a release should be:
264265
There is an example nipy data package ``nipy-examplepkg`` in the
265266
``examples`` directory of the NIPY repository.
266267

267-
The machinery for creating and maintaining data packages is available with::
268-
269-
svn co https://nipy.svn.sourceforge.net/svnroot/nipy/data-packaging/trunk
268+
The machinery for creating and maintaining data packages is available at
269+
http://github.com/nipy/data-packaging
270270

271271
See the ``README.txt`` file there for more information.

0 commit comments

Comments
 (0)