Skip to content

Commit dc01d01

Browse files
matthew-brettmatthew-brett
committed
Merge pull request #204 from matthew-brett/pre-release-doc-cleanup
MRG: Pre release doc cleanup Various cleanups of the documentation.
2 parents 10cd8c1 + 60d6646 commit dc01d01

Some content is hidden

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

69 files changed

+2022
-4290
lines changed

‎AUTHOR

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
Alexis Roche
2-
Benjamin Thyreau
3-
Bertrand Thirion
4-
Chris Burns
5-
Cindee Madison
6-
Fernando Perez
7-
Gael Varoquaux
8-
Jarrod Millman
9-
Jonathan Taylor
10-
Jean-Baptiste Poline
11-
Merlin Keller
12-
Tom Waite
13-
Virgile Fritsch
14-
Yaroslav Halchenko
1+
Alexis Roche <alexis.roche@gmail.com>
2+
Bertrand Thirion <bertrand.thirion@inria.fr>
153
Brian Hawthrorne
4+
Chris Burns <cburns@berkeley.edu>
5+
Cindee Madison <cindee@berkeley.edu>
6+
Fernando Perez <Fernando.Perez@berkeley.edu>
7+
Gael Varoquaux <gael.varoquaux@normalesup.org>
8+
Jarrod Millman <jarrod.millman@gmail.com>
9+
Jean-Baptiste Poline <jbpoline@gmail.com>
10+
Jonathan Taylor <jonathan.taylor@stanford.edu>
11+
Matthew Brett <matthew.brett@gmail.com>
12+
Merlin Keller
1613
Mike Trumpis
1714
Tim Leslie
18-
Matthew Brett <matthew.brett@gmail.com>
15+
Tom Waite
16+
Virgile Fritsch <virgile.fritsch@gmail.com>
17+
Yaroslav Halchenko <debian@onerussian.com>

‎INSTALL

Lines changed: 0 additions & 169 deletions
This file was deleted.

‎LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2006-2010, NIPY Developers
1+
Copyright (c) 2006-2012, NIPY Developers
22
All rights reserved.
33

44
Redistribution and use in source and binary forms, with or without

‎MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
include AUTHOR COPYING Makefile* MANIFEST.in setup* README.* INSTALL THANKS
1+
include AUTHOR COPYING Makefile* MANIFEST.in setup* README.* THANKS
22
include Changelog TODO
33
include *.py
44
include site.*

‎README

Lines changed: 0 additions & 70 deletions
This file was deleted.

‎README.rst

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
.. -*- rest -*-
2+
.. vim:syntax=rest
3+
4+
====
5+
NIPY
6+
====
7+
8+
Neuroimaging tools for Python.
9+
10+
The aim of NIPY is to produce a platform-independent Python environment for the
11+
analysis of functional brain imaging data using an open development model.
12+
13+
In NIPY we aim to:
14+
15+
1. Provide an open source, mixed language scientific programming
16+
environment suitable for rapid development.
17+
18+
2. Create sofware components in this environment to make it easy
19+
to develop tools for MRI, EEG, PET and other modalities.
20+
21+
3. Create and maintain a wide base of developers to contribute to
22+
this platform.
23+
24+
4. To maintain and develop this framework as a single, easily
25+
installable bundle.
26+
27+
NIPY is the work of many people. We list the main authors in the file ``AUTHOR``
28+
in the NIPY distribution, and other contributions in ``THANKS``.
29+
30+
Website
31+
=======
32+
33+
Current information can always be found at the NIPY website::
34+
35+
http://nipy.org/nipy
36+
37+
Mailing Lists
38+
=============
39+
40+
Please see the developer's list::
41+
42+
http://projects.scipy.org/mailman/listinfo/nipy-devel
43+
44+
Code
45+
====
46+
47+
You can find our sources and single-click downloads:
48+
49+
* `Main repository`_ on Github.
50+
* Documentation_ for all releases and current development tree.
51+
* Download as a tar/zip file the `current trunk`_.
52+
* Downloads of all `available releases`_.
53+
54+
.. _main repository: http://github.com/nipy/nipy
55+
.. _Documentation: http://nipy.org/nipy
56+
.. _current trunk: http://github.com/nipy/nipy/archives/master
57+
.. _available releases: http://github.com/nipy/nipy/downloads
58+
59+
Dependencies
60+
============
61+
62+
To run NIPY, you will need:
63+
64+
* python_ >= 2.5. We don't yet run on python 3, sad to say.
65+
* numpy_ >= 1.2
66+
* scipy_ >= 0.7.0
67+
* sympy_ >= 0.6.6
68+
* nibabel_ >= 1.2
69+
70+
You will probably also like to have:
71+
72+
* ipython_ for interactive work
73+
* matplotlib_ for 2D plotting
74+
* mayavi_ for 3D plotting
75+
76+
.. _python: http://python.org
77+
.. _numpy: http://numpy.scipy.org
78+
.. _scipy: http://www.scipy.org
79+
.. _sympy: http://sympy.org
80+
.. _nibabel: http://nipy.org/nibabel
81+
.. _ipython: http://ipython.scipy.org
82+
.. _matplotlib: http://matplotlib.sourceforge.net
83+
.. _mayavi: http://code.enthought.com/projects/mayavi/
84+
85+
License
86+
=======
87+
88+
We use the 3-clause BSD license; the full license is in the file ``LICENSE`` in
89+
the nipy distribution.

0 commit comments

Comments
 (0)