.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH PYMVPA2-TUTORIAL "1" "April 2017" "pymvpa2-tutorial 2.6.1" "User Commands"
.SH NAME
pymvpa2-tutorial \- start a PyMVPA tutorial session
.SH SYNOPSIS
.B pymvpa2-tutorial
[\fI\,options\/\fR] [\fI\,ipython options\/\fR]
.SH DESCRIPTION
Wrapper around the IPython executable creating a session directory for working
with the PyMVPA tutorial. The necessary tutorial data is copied (or symlinked,
if possible) into the session directory. If the tutorial shall run in IPython's
notebook the relevant notebook files are copied into the session directory as
well. Any additional options are passed on to IPython. IPython is executed
in the tutorial session directory, and any potential relative path
configurations (such as PYTHONPATH) need to take this into account.
.SH OPTIONS
.TP
\fB\-\-help\fR
print this help and exit
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-\-use\-qtconsole\fR
start an IPython qtconsole
.TP
\fB\-\-use\-notebook\fR
start an IPython notebook server
.TP
\fB\-\-workdir\fR
path to the tutorial session directory.
Default: \fI\,$HOME/pymvpa2_tutorial\/\fP
.TP
\fB\-\-clean\-workdir\fR
delete tutorial session data on exit
.TP
\fB\-\-overwrite\-notebook\fR
overwrite existing notebook files in the tutorial
session directory
.TP
\fB\-\-tutorial\-data\-path=\fR<path>
path to the tutorial data (need to contain the
\&'data' directory)
.TP
\fB\-\-tutorial\-notebooks\-path=\fR<path>
path to the tutorial notebooks