Skip to content

Commit

Permalink
Updated manual & quickstart.
Browse files Browse the repository at this point in the history
  • Loading branch information
jansaputra committed Mar 31, 2011
1 parent 701e1e8 commit f242a11
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
11 changes: 11 additions & 0 deletions QUICKSTART
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,21 @@ Either open ssa.jar using the GUI of your operating system
java -jar ssa.jar

on the command line.
If you want to run SSA on very large data sets, it might be necessary
to increase the Java heap space. For example, the following command
would start the toolbox with 512M Java heap space:

java -Xmx512M -jar ssa.jar

In order to run SSA under Matlab, change into this directory and
type

help ssa

on the Matlab command line. For an example see ssa_example.m.
Also here it might be necessary to increase the Java heap space which
Matlab uses. The following website explains how to do that:

http://www.mathworks.com/support/solutions/en/data/1-18I2C

For further information have a look at the manual.
12 changes: 10 additions & 2 deletions manual/manual.tex
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,14 @@ \section{Installation and Running}
\begin{center}
\texttt{java -jar ssa.jar}
\end{center}
on the command line of your operating system. If you want to use the SSA~Toolbox directly
on the command line of your operating system.

In some cases, if you want to run SSA on very large data sets, it might be necessary to start the toolbox
with a higher amount of Java heap space (in those cases the SSA toolbox will inform you
about this issue). There is a section in the Frequently Asked Questions which explains how to do that
(see Section~\ref{sec:faq}).

If you want to use the SSA~Toolbox directly
from Matlab, you can use the wrapper script \texttt{ssa.m}. Type \texttt{help ssa} on
the Matlab command line to find out about the format of its input and output parameters.
Note that if you invoke the SSA Toolbox from within Matlab, it will use its
Expand Down Expand Up @@ -452,6 +459,7 @@ \section{Example}
\FloatBarrier

\section{Frequently Asked Questions}
\label{sec:faq}

\paragraph{When should I use SSA?}

Expand Down Expand Up @@ -494,7 +502,7 @@ \section{Frequently Asked Questions}
desired size.

If you are using the toolbox from within Matlab, you have to increase the Java heap space which Matlab uses.
The following website explains how to do this:
The following website explains how to do that:
\begin{center}
\url{http://www.mathworks.com/support/solutions/en/data/1-18I2C}
\end{center}
Expand Down

0 comments on commit f242a11

Please sign in to comment.