this is for holding javascript data
Antonino Ingargiola edited Introduction.tex
about 9 years ago
Commit id: 6fa9505d68c766791222b4d972feaac188041b88
deletions | additions
diff --git a/Introduction.tex b/Introduction.tex
index d2aef95..7cc8563 100644
--- a/Introduction.tex
+++ b/Introduction.tex
...
\subsection{Installing FRETBursts}
\label{sec:install}
Installing FRETBursts is
a analogous to installing any standard python
package that requires package. A python environment needs to be installed, preferentially
through a
standard set of scientific python
libraries, included by distribution which conveniently include
all the major scientific
python
distributions.
Specifically, numerical computations are performed with numpy/scipy,
plotting is based on matplotlib and seaborn, a few core functions are
optimized with cython and the software is preferentially run through
a Jupyther (IPython) Notebook. libraries.
For new python users we suggest installing
\href{https://store.continuum.io/cshop/anaconda/}{Continuum Anaconda}
python
distribution. distribution and then install (or update) FRETBursts
can be installed through the standard python package manager (PIP)
or through \href{http://conda.pydata.org/docs/}{conda}.
Alternatively the latest development version can be downloaded directly
from GitHub. For more information on different installation methods refer to the
\href{http://fretbursts.readthedocs.org/en/latest/getting_started.html}{Getting Started}
section in the FRETBursts documentation.
\subsection{Executing FRETBursts}
\label{sec:import}
In general, we suggest to import FRETbursts with the
expression: command:
\begin{verbatim}
>>> import conda install fretbursts
as fb -c tritemio
\end{verbatim}
after which all For more information on different installation methods refer to the
FRETBursts functions will be availabe under \href{http://fretbursts.readthedocs.org/en/latest/getting_started.html}{Getting Started}
section in the
\verb|fb.|
prefix. In this article, for brevity, we assume that FRETBursts
is imported
with the shortcut form instead:
\begin{verbatim}
>>> from fretbursts import *
\end{verbatim} documentation.
that allows skipping the \verb|fb.| prefix and it will also import some common
numeric libraries (i.e. \textit{numpy} FRETBursts depends on a standard set of scientific
python libraries, namely, numpy/scipy for numerical computations,
matplotlib and
\textit{matplotlib.pyplot}
imported as \verb|np| seaborn for plotting. Optionally, a few core functions are
optimized with cython and
\verb|plt| respectively). the software is preferentially run through
a Jupyther (IPython) Notebook (optional).
For a complete list of dependencies can be found in the
\href{http://fretbursts.readthedocs.org/en/latest/getting_started.html}{Getting Started}
section in the FRETBursts documentation.
In order \subsection{Running FRETBursts}
The preferential way to
enable the reproducibility of the analysis and to ease
the sharing execute FRETBurts is by running one of the
complete workflow we encourage using
FRETBursts
through
the IPython Notebook environment.
IPython notebooks tutorials which are
documents in
which the
code is interspersed with
prose in form of Jypyther notebooks.
Jupyther (formerly IPython) notebooks are documents,
accessed through a
web-based format web browser, that
can contain
math formulas, hyperlinks both code and
figures (or anything else a web browser rich text (including formulas, hyperlinks, figures, etc...).
FRETBursts tutorials are notebook that can
display).
Furthermore, the be re-executed,
modified or used to process new data files with minimal modifications.
The "notebook workflow"\cite{Shen_2014}
has the advantage
of automatically recording not only
eases
the
all analysis
commands and parameters comprehension (by integrating the cone in a rich document)
but also
the data file names, greatly enhance its reproducibility by saving an execution trail
including software
versions versions, input files, parameters, commands and
all
the
full output
(figures, analysis results (text, figures, tables,
etc...) in a single document that can be interactively
modified and re-executed. etc...).
All Given the
FRETBursts tutorials are
ipython notebooks and, in fact, modality of execution, running FRETBurst does not require
any prior python knowledge. The user only needs familiarize with the
preferred way notebook graphical environment to
start a new analysis is by
copying be able to navigate and
modifying a pre-existing FRETBursts notebook. run the notebooks.