Skip to content

WIP: Pre release doc cleanup #204

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 21 commits into from
Jul 22, 2012
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
7446873
DOC: clean up old sphinx extension machinery
matthew-brett Jul 20, 2012
f66cefa
DOC: fix section heading in fmri.utils
matthew-brett Jul 20, 2012
f2c0fba
DOC: fix plot commands in glm_spec
matthew-brett Jul 20, 2012
f0a8ced
DOC: update plots to new interfaces
matthew-brett Jul 20, 2012
7112357
DOC: update dependencies for sphinx doc build
matthew-brett Jul 21, 2012
bf238c1
DOC: add nipy github repo to side bar
matthew-brett Jul 21, 2012
5d7f558
DOC: update some links
matthew-brett Jul 21, 2012
e3f492c
DOC: rewrite README file, rename to .rst
matthew-brett Jul 21, 2012
515f497
DOC: update date in LICENSE
matthew-brett Jul 21, 2012
2287b5b
DOC: update THANKS and AUTHOR
matthew-brett Jul 21, 2012
f755656
DOC: move install into documentation tree
matthew-brett Jul 21, 2012
c6b4dc1
DOC: point to collated data installation page
matthew-brett Jul 21, 2012
fdd6824
DOC: add InTemporaryDirectory instructions
matthew-brett Jul 22, 2012
06e66ca
DOC: typos and whitespace in labs documentation
matthew-brett Jul 22, 2012
83ff905
DOC: harmonize README and info.py
matthew-brett Jul 22, 2012
0e5a96d
DOC: refactoring coordinate map discussion
matthew-brett Jul 22, 2012
583a687
DOC: add links back to installation page
matthew-brett Jul 22, 2012
b619036
DOC: refactor ipython to doctests in basic_io
matthew-brett Jul 22, 2012
5739ef2
DOC: small reformatting for glm_spec tutorial
matthew-brett Jul 22, 2012
4f59d44
DOC: minor cleanups to user part of docs
matthew-brett Jul 22, 2012
60d6646
DOC: move software_design to code_discussions
matthew-brett Jul 22, 2012
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
29 changes: 14 additions & 15 deletions AUTHOR
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
Alexis Roche
Benjamin Thyreau
Bertrand Thirion
Chris Burns
Cindee Madison
Fernando Perez
Gael Varoquaux
Jarrod Millman
Jonathan Taylor
Jean-Baptiste Poline
Merlin Keller
Tom Waite
Virgile Fritsch
Yaroslav Halchenko
Alexis Roche <alexis.roche@gmail.com>
Bertrand Thirion <bertrand.thirion@inria.fr>
Brian Hawthrorne
Chris Burns <cburns@berkeley.edu>
Cindee Madison <cindee@berkeley.edu>
Fernando Perez <Fernando.Perez@berkeley.edu>
Gael Varoquaux <gael.varoquaux@normalesup.org>
Jarrod Millman <jarrod.millman@gmail.com>
Jean-Baptiste Poline <jbpoline@gmail.com>
Jonathan Taylor <jonathan.taylor@stanford.edu>
Matthew Brett <matthew.brett@gmail.com>
Merlin Keller
Mike Trumpis
Tim Leslie
Matthew Brett <matthew.brett@gmail.com>
Tom Waite
Virgile Fritsch <virgile.fritsch@gmail.com>
Yaroslav Halchenko <debian@onerussian.com>
169 changes: 0 additions & 169 deletions INSTALL

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2006-2010, NIPY Developers
Copyright (c) 2006-2012, NIPY Developers
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
include AUTHOR COPYING Makefile* MANIFEST.in setup* README.* INSTALL THANKS
include AUTHOR COPYING Makefile* MANIFEST.in setup* README.* THANKS
include Changelog TODO
include *.py
include site.*
Expand Down
70 changes: 0 additions & 70 deletions README

This file was deleted.

89 changes: 89 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
.. -*- rest -*-
.. vim:syntax=rest

====
NIPY
====

Neuroimaging tools for Python.

The aim of NIPY is to produce a platform-independent Python environment for the
analysis of functional brain imaging data using an open development model.

In NIPY we aim to:

1. Provide an open source, mixed language scientific programming
environment suitable for rapid development.

2. Create sofware components in this environment to make it easy
to develop tools for MRI, EEG, PET and other modalities.

3. Create and maintain a wide base of developers to contribute to
this platform.

4. To maintain and develop this framework as a single, easily
installable bundle.

NIPY is the work of many people. We list the main authors in the file ``AUTHOR``
in the NIPY distribution, and other contributions in ``THANKS``.

Website
=======

Current information can always be found at the NIPY website::

http://nipy.org/nipy

Mailing Lists
=============

Please see the developer's list::

http://projects.scipy.org/mailman/listinfo/nipy-devel

Code
====

You can find our sources and single-click downloads:

* `Main repository`_ on Github.
* Documentation_ for all releases and current development tree.
* Download as a tar/zip file the `current trunk`_.
* Downloads of all `available releases`_.

.. _main repository: http://github.com/nipy/nipy
.. _Documentation: http://nipy.org/nipy
.. _current trunk: http://github.com/nipy/nipy/archives/master
.. _available releases: http://github.com/nipy/nipy/downloads

Dependencies
============

To run NIPY, you will need:

* python_ >= 2.5. We don't yet run on python 3, sad to say.
* numpy_ >= 1.2
* scipy_ >= 0.7.0
* sympy_ >= 0.6.6
* nibabel_ >= 1.2

You will probably also like to have:

* ipython_ for interactive work
* matplotlib_ for 2D plotting
* mayavi_ for 3D plotting

.. _python: http://python.org
.. _numpy: http://numpy.scipy.org
.. _scipy: http://www.scipy.org
.. _sympy: http://sympy.org
.. _nibabel: http://nipy.org/nibabel
.. _ipython: http://ipython.scipy.org
.. _matplotlib: http://matplotlib.sourceforge.net
.. _mayavi: http://code.enthought.com/projects/mayavi/

License
=======

We use the 3-clause BSD license; the full license is in the file ``LICENSE`` in
the nipy distribution.
Loading