Minargon - Detector Monitoring for SBN
============================================

Minargon is a website used for online monitoring in the SBN
collaboration (in the SBND and ICARUS detectors)

Quickstart
----------

Note: to install minargon, you need recent versions of pip, virtualenv,
and python. On the fermilab gpvm servers, setup python v2_7_14 through
ups. Then, run the `virtualenv` commands below with `python
~gputnam/virtualenv-15.1.0/virtualenv.py` (this is an instance of
virtualenv that I have setup myself for use).

To run a local copy of minargon, first create a virtual environment and activate
it.

    $ virtualenv venv
    $ . venv/bin/activate

Make sure you have a recent version of pip:

    $ pip install --upgrade pip

Now, clone the minard repository, and install the prerequisites:

    $ git clone https://github.com/gputnam/minargon.git
    $ cd minargon
    $ pip install -r requirements.txt

Minargon needs a configuration file to run with the settings of where
the Redis Database is located. An example settings file is given in
`example_settigns.conf`. Either use those settings, or make a new
settings file (if your database in a different location). Then set:

    $ export MINARGON_SETTINGS=`pwd`/your_settings_file.conf

Now, you can start up the webserver:

    $ ./runserver.py

And you should be able to open your web browser to localhost:5000 and see it.

Note that if you are running on a remote server, you will have to
forward port 5000 back to your laptop in order to view the website. To
do this, when ssh-ing into the remote server, add in the parameter: `-L
5000:localhost:5000`.

Authors
-------
Minard was originally written for the SNO+ experiment.

Minargon is a website inspired from Minard and using some of the same
technologies.