[med-svn] [python-mne] 41/376: better documentation

[Yaroslav Halchenko]

This is an automated email from the git hooks/post-receive script.

yoh pushed a commit to annotated tag v0.1
in repository python-mne.

commit 2b73715fca1d5b341151f0e7f6a2677faa7aa34b
Author: Alexandre Gramfort <alexandre.gramfort at inria.fr>
Date:   Thu Jan 20 16:04:52 2011 -0500

    better documentation
---
 doc/source/getting_started.rst             | 12 +++++++++++-
 doc/source/getting_started_at_martinos.rst | 27 +++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 1 deletion(-)

diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst
index cdc7495..b54a0b3 100644
--- a/doc/source/getting_started.rst
+++ b/doc/source/getting_started.rst
@@ -3,10 +3,20 @@
 Getting Started
 ===============
 
+Inside the Martinos Center
+--------------------------
+People within the MGH/MIT/HMS Martinos Center should follow
+`internal instructions <getting_started_at_martinos.html>`_.
+
+MNE is *already installed* on your system.
+
+Outside the Martinos Center
+---------------------------
+
 MNE is written in pure Python making it easy to setup of
 any machine with Python >=2.4, Numpy >= 1.1 and Scipy >= 0.6.
 
-To test that everything worked properly, open up IPython::
+To test that everything works properly, open up IPython::
 
     ipython
     
diff --git a/doc/source/getting_started_at_martinos.rst b/doc/source/getting_started_at_martinos.rst
new file mode 100644
index 0000000..91cfdb3
--- /dev/null
+++ b/doc/source/getting_started_at_martinos.rst
@@ -0,0 +1,27 @@
+.. _getting_started:
+
+Getting Started at the Martinos Center
+======================================
+
+You first need to activate the python scientific environment.
+In a terminal do:
+
+    source /usr/pubsw/packages/python/2.6/scientificpython/bin/tcsh_activate
+
+If you use Bash replace the previous instruction with:
+
+    source /usr/pubsw/packages/python/2.6/scientificpython/bin/bash_activate
+
+Then start the python interpreter with:
+
+    ipython
+
+Although all of the examples in this documentation are in the style
+of the standard Python interpreter, the use of IPython is highly
+recommended. Then type::
+
+    >>> import mne
+
+If you get a new prompt with no error messages, you should be good to go.
+Start with the `examples <auto_examples/index.html>`_
+

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/python-mne.git