h1. Online reconstruction quick start guide

{{>toc}}

This is a stripped down set of basic instructions to get distributed spill transformation and online reconstruction up and running. For full details, see the pages under [[MAUSDevs#Online-reconstruction|MAUS developer documentation - online reconstruction]].

h2. Build MAUS and install Python libraries

* Download and unpack MAUS to a directory, e.g. @/home/mice/maus@.

* Build,

<pre>

cd maus

source env.sh

./install_build_test.bash 

</pre>

* Install MAUS web front-end dependencies,

<pre>

easy_install pil

easy_install django

easy_install magickwand

</pre>

h2. Download and configure the MAUS web-front end

* Open a new window,

<pre>

xterm &

</pre>

* Download and unpack MAUS web front end to a directory e.g. @/home/mice/maus-apps@.

* Configure the web front-end,

<pre>

cd /home/mice/maus

source env.sh

cd /home/mice/maus-apps

./configure --with-maus

</pre>

* Copy in sample data,

<pre>

cp images/sample-* media/raw/

</pre>

h2. EITHER set up Django web server

* Start up the web server:

<pre>

source env.sh

python src/mausweb/manage.py runserver localhost:9000

</pre>

* Go to web site http://localhost:9000/maus

* You should see a MAUS page listing no histograms.

* Type @sample@ into the search form.

* A new page should appear with two histograms.

* Delete the images and the thumbnails:

<pre>

rm -rf media/thumbs/*

rm -rf media/raw/*

</pre>

h2. OR set up Apache 2 web server

* Set up Apache 2,

<pre>

$ su

$ chmod go+rx /home/mice

$ emacs -nw /usr/local/apache2/bin/envvars

</pre>

* Add before the line "LD_LIBRARY_PATH":

<pre>

source /home/mice/maus/env.sh

source /home/mice/maus-apps/env.sh

</pre>

* Restart Apache 2,

<pre>

/usr/local/apache2/bin/apachectl restart

</pre>

* Go to web site http://localhost:80/maus

* You should see a MAUS page listing no histograms.

* Type @sample@ into the search form.

* A new page should appear with two histograms.

* Delete the images and the thumbnails:

<pre>

rm -rf media/thumbs/*

rm -rf media/raw/*

</pre>

h2. Start up Celery worker

* Open a new window,

<pre>

xterm &

</pre>

* Configure the environment:

<pre>

cd /home/mice/maus

source env.sh

</pre>

* Start up a Celery worker that will use up to 8 cores:

<pre>

celeryd -c 8 -l INFO --purge

</pre>

h2. Check Celery worker

* Open a new window,

<pre>

xterm &

</pre>

* Configure the environment:

<pre>

cd /home/mice/maus

source env.sh

</pre>

* Check that the Celery worker has spawned 8 sub-processes,

<pre>

ps -a 

</pre>

* There should be 9 @celeryd@ processes in total.

h2. Run a simple example

* Run a sample histogram workflow,

<pre>

./bin/examples/simple_histogram_example.py -type_of_dataflow=multi_process  

</pre>

* After 4 spills have been processed it should just sit there so,

<pre>

CTRL-C

</pre>

* Check that 4 histograms have been output

<pre>

ls -l

</pre>

* There should be 4 @eps@ and 4 @json@ files.

* Check the database contains the associated documents 

<pre>

./bin/utilities/summarise_mongodb.py --database ALL 

</pre>

* @mausdb@ should contain 4 spills.

h2. Run an offline reconstruction example

* Open a new window,

<pre>

xterm &

</pre>

* Configure the environment:

<pre>

cd /home/mice/maus

source env.sh

</pre>

* Edit @bin/user/reconstruct_daq.py@ and ensure that the line,

<pre>

# my_input = MAUS.InputCppDAQOnlineData()

</pre>

* is commented out, and the line,

<pre>

my_input = MAUS.InputCppDAQOfflineData()

</pre>

* is uncommented.

* Start a client to read data and transform it,

<pre>

./bin/user/reconstruct_daq.py -type_of_dataflow=multi_process_input_transform -daq_data_file="03386.000" -daq_data_path=/home/mice/data/ 

</pre>

* Open a new window,

<pre>

xterm &

</pre>

* Configure the environment:

<pre>

cd /home/mice/maus

source env.sh

source /home/mice/maus_apps/env.sh

</pre>

* Start a client to merge data and output it,

<pre>

./bin/user/reconstruct_daq.py -type_of_dataflow=multi_process_merge_output

</pre>

h2. Run an online reconstruction example

* Open a new window,

<pre>

xterm &

</pre>

* Configure the environment:

<pre>

cd /home/mice/maus

source env.sh

</pre>

* Edit @bin/user/reconstruct_daq.py@ and ensure that the line,

<pre>

# my_input = MAUS.InputCppDAQOfflineData()

</pre>

* is commented out, and the line,

<pre>

my_input = MAUS.InputCppDAQOnlineData()

</pre>

* is uncommented.* Set the DAQ connection settings:

<pre>

export DATE_DB_MYSQL_DB=DATE_CONFIG

export DATE_DB_MYSQL_USER=daq

export DATE_DB_MYSQL_PWD=daq

export DATE_DB_MYSQL_HOST=miceacq07

export DATE_SITE=/dateSite

export DATE_HOSTNAME=`hostname`

</pre>

* Start a client to read data and transform it,

<pre>

./bin/user/reconstruct_daq.py -type_of_dataflow=multi_process_input_transform

</pre>

* Open a new window,

<pre>

xterm &

</pre>

* Configure the environment:

<pre>

cd /home/mice/maus

source env.sh

source /home/mice/maus_apps/env.sh

</pre>

* Start a client to merge data and output it,

<pre>

./bin/user/reconstruct_daq.py -type_of_dataflow=multi_process_merge_output

</pre>