iBioSim/docs/iBioSim_Install.tex
2015-01-25 22:54:38 +00:00

161 lines
6.8 KiB
TeX

\documentclass[titlepage,11pt]{article}
\textwidth 6.5in
\textheight 9in
\oddsidemargin -0.2in
\topmargin -0.5in
\usepackage{indentfirst,graphics,alltt,epsfig,color}
\title{iBioSim Installation Instructions}
\author{Chris J. Myers}
% \date{Created: August 11th, 2008\\
% Last Revised: August 14th, 2008
% }
\begin{document}
\maketitle
%show only subsection granularity in the toc
%\setcounter{tocdepth}{2}
\tableofcontents
\clearpage
%\setlength{\parindent}{0em}
%\setlength{\parskip}{10pt}
\section{General Requirements}
\noindent
There are versions of {\tt iBioSim} available for Windows, Linux, and
MacOS. You can download the appropriate installation file from:\\
%%tth:\begin{html}<a href="http://www.async.ece.utah.edu/iBioSim/">\end{html}
{\tt http://www.async.ece.utah.edu/iBioSim}.
%%tth:\begin{html}</a>\end{html}
{\tt iBioSim} requires that you have
%%tth:\begin{html}<a href="http://java.sun.com/javase/downloads/index.jsp">\end{html}
Java Runtime Environment 1.6
%%tth:\begin{html}</a>\end{html}
or higher install on your system. It is also useful to have
%%tth:\begin{html}<a href="http://www.graphviz.org/">\end{html}
Graphviz.
%%tth:\begin{html}</a>\end{html}
Also, you should associate files with a ``.dot'' extension with the
{\tt Graphviz} tool, and files with the ``.xhtml'' extension to your
web browswer. There is also a pure java version available that
supports most though not all features of {\tt iBioSim}. This is a good option when having trouble with the other installations, since it is machine independent.
\section{Java Installation}
\noindent
To install the pure Java version, you need to download {\tt iBioSim-2.8-Java.zip} and unzip it in the directory you wish to install. The {\tt iBioSim.jar} file should be executable, but may require being invoked using the explicit command: {\tt java -jar iBioSim.jar}.
The {\tt iBioSim.mac64} script makes it look better on Mac environment.
\section{MacOS Installation}
\noindent
To install on MacOS, you need to download {\tt
iBioSim-$\langle$version$\rangle$-MacOS.dmg} file. You should then
open this file with {\tt DiskImageMounter.app}. This should open up
this disk image in {\tt finder}. You should then copy the contents of
this disk image to your Applications folder. You should then be able
to start {\tt iBioSim} by double-clicking on this application.
\section{Windows Installation}
\noindent
Download and execute {\tt iBioSim-$\langle$version$\rangle$-Setup.exe}.\\
The installation uses InstallJammer. It first asks you for your
preferred installation language. Make your selection and press {\tt OK}.
\includegraphics[height=40mm]{screenshots/language}
The next screen tells you that you what version you are installing.
Press {\tt Next} to continue.
\includegraphics[height=95mm]{screenshots/setup}
Next, it ask you for an installation location. Please make sure to
select a path that does not have any spaces or special symbols as
these cause problems with {\tt iBioSim}.
\includegraphics[height=95mm]{screenshots/location}
You are now ready to install. Press {\tt Next} to continue.
\includegraphics[height=95mm]{screenshots/confirm}
You are all done. Press {\tt Finish}. If selected, {\tt iBioSim}
will launch immediately. Otherwise, you can start it using your
desktop shortcut or from your start menu.
\includegraphics[height=95mm]{screenshots/finish}
In your start menu, there should be an option to uninstall. If you
select this, it will ask if you are sure then proceed to completely
remove {\tt iBioSim} from your system. It is highly recommended that
you remove {\tt iBioSim} using this uninstall procedure before
installing a new version.
\section{Linux Installation}
\noindent
Since InstallJammmer is also used for the Linux install, the
installation instructions are essentially the same.
First, download {\tt iBioSim-$\langle$version$\rangle$-Linux-x86\_64-Install}.
Open a terminal and browse to where this file was download. You must
make this file executable:\\
{\tt chmod u+x iBioSim-$\langle$version$\rangle$-Linux-x86\_64-Install}.
You should then execute this file:\\
{\tt ./iBioSim-$\langle$version$\rangle$-Linux-x86\_64-Install}.
This starts InstallJammer. It first asks you for your
preferred installation language. Make your selection and press {\tt OK}.
\includegraphics[height=40mm]{screenshots/language}
The next screen tells you that you what version you are installing.
Press {\tt Next} to continue.
\includegraphics[height=95mm]{screenshots/setup}
Next, it ask you for an installation location. Please make sure to
select a path that does not have any spaces or special symbols as
these cause problems with {\tt iBioSim}.
\includegraphics[height=95mm]{screenshots/location}
You are now ready to install. Press {\tt Next} to continue.
\includegraphics[height=95mm]{screenshots/confirm}
You are all done. Press {\tt Finish}. If selected, {\tt iBioSim}
will launch immediately. Otherwise, you can start it using your
desktop shortcut or from your start menu.
\includegraphics[height=95mm]{screenshots/finish}
In your start menu, there should be an option to uninstall. If you
select this, it will ask if you are sure then proceed to completely
remove {\tt iBioSim} from your system. It is highly recommended that
you remove {\tt iBioSim} using this uninstall procedure before
installing a new version.
Note that since there are a large number of different linux installations, there can be problems especially with older installations. If you are having problems though, first log out and back in. There are some environment variables that need to be set. If you are still having problems, then read on.
Our linux installations are currently built for 32-bit and 64-bit versions of Fedora 15. While the Java parts of our program port smoothly, there are often issues with the dynamic libraries and the C/C++ programs {\tt reb2sac} and {\tt GeneNet}. If you are having a problem, the first step is to download and build libsbml Version 5.0. You will need to replace the libsbml.so* and libsbmlj.so files with your build of libsbml in either lib or lib64 depending on whether you are using a 32-bit or 64-bit machine. At this point, you should be able to start {\tt iBioSim}. However, if you are still having problems, send an email to {\tt myers@ece.utah.edu} including information about your OS and any error messages when you try to execute {\tt iBioSim} from the command line.
You should also now test {\tt reb2sac} and {\tt GeneNet}. In your install directory, try the following:
\begin{itemize}
\item cd bin
\item export LD\_LIBRARY\_PATH=\$BIOSIM/lib:\$LD\_LIBRARY\_PATH \\
Note that this is for bash shell, so you may need to change for your shell, if not bash.
\item ./reb2sac
\item ./GeneNet
\end{itemize}
You should see the usage lines for these programs. If you do not, you may need custom builds, contact {\tt myers@ece.utah.edu}.
\end{document}