Skip to content

Commit

Permalink
bump documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wds15 committed Oct 6, 2019
1 parent 726faf4 commit 8c18f2b
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 10 deletions.
27 changes: 22 additions & 5 deletions src/docs/cmdstan-guide/getting-started.tex
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ \section{Installation}
download.
\item The \code{make} utility program. \\
This is not strictly necessary, but will make the build process
easy. On the Windows platform the \code{mingw32-make} variant is
needed to build \CmdStan. This \code{make} variant is part of RTools
(\url{https://cran.rstudio.com/bin/windows/Rtools/}). The rest of
the documentation assumes \code{make} (\code{mingw32-make} on
Windows) is available.
easy. On Windows the \code{mingw32-make} variant is needed to build
\CmdStan. This is a \code{make} variant and can be installed as part
of RTools (\url{https://cran.rstudio.com/bin/windows/Rtools/}). The
rest of the documentation assumes \code{make} (\code{mingw32-make}
on Windows) is available.
\item A \Cpp compiler.
\end{itemize}

Expand Down Expand Up @@ -95,6 +95,23 @@ \section{Building \CmdStan}
\textbf{Warning:} \ The \code{make} program may take 10+ minutes and
consume 2+ GB of memory to build \CmdStan. Please use
\code{mingw32-make} on Windows (available from RTools).
\item \emph{Windows only:} \, \CmdStan requires that the Intel TBB
library, which is build by the above command, can be found by the
Windows system. This requires that the directory
\verb+<cmdstan-home>/stan/lib/stan_math/lib/tbb+ is part of the
\code{PATH} environment variable. To permanently make this setting
for the current user, you may execute:
%
\begin{quote}
\begin{Verbatim}[fontshape=sl]
> mingw32-make install-tbb
\end{Verbatim}
\end{quote}
%
Don't forget to open a new shell where these new settings will
take effect. For other platforms this step is not needed, since
the absolute path to the Intel TBB library is linked into Stan
programs (not possible on Windows).
\end{enumerate}
%
When \CmdStan is successfully built, the \code{make} program will
Expand Down
7 changes: 3 additions & 4 deletions src/docs/cmdstan-guide/installation.tex
Original file line number Diff line number Diff line change
Expand Up @@ -672,10 +672,9 @@ \subsection{GNU Make Build Tool}
\item Tested Versions: 3.81 (Mac OS X), 3.79 (Windows 7)
\end{itemize}
%
On Windows the \code{mingw32-make} variant must be used, since the
Intel TBB makefiles require this type of make. This variant is
available as part of RTools
\url{https://cran.rstudio.com/bin/windows/Rtools/}.
On Windows \code{mingw32-make} variant must be used as a requirement
to build the Intel TBB. This variant of \code{make} is available as
part of RTools \url{https://cran.rstudio.com/bin/windows/Rtools/}.


\subsection{Doxygen Documentation Generator}
Expand Down

0 comments on commit 8c18f2b

Please sign in to comment.