File name:      readme.txt

Authors:        Roland Doerfer
                Helmut Schiller
                Marco Peters

Affiliation:    BEAM Development Team
                Brockmann Consult GmbH
                Max-Planck-Strasse 1
                D-21502 Geesthacht, Germany
                www.brockmann-consult.de

E-mails:        doerffer@gkss.de
                helmut.schiller@gkss.de
                marco.peters@brockmann-consult.de

Release date:   08. November 2006


Introduction
------------

This file briefly describes the installation and use of the
accompanying software package.


Requirements
------------

The Meris Case-2 Regional processor is a plug-in module for the
BEAM software developed by Brockmann Consult for ESA. This latter software must
of course be installed prior to the MerisC2R processor.

The BEAM software includes an application programming interface (API) and
a set of executable tools to facilitate the use of MERIS, AATSR and further
ASAR data products of the ESA ENVISAT satellite.

It can be freely downloaded from:

http://www.brockmann-consult.de/beam/downloads.html


Installation
------------

The BEAM package (here : BEAM VISAT Version 3.6) is installed within a
particular, user-selectable, directory. For the purpose of this documentation
file, that directory will be denoted $BEAM_HOME$. After installation of the
BEAM package, this directory should contain the following subdirectories
and files:

    $BEAM_HOME$
        |- auxdata/
        |- bin/
        |- docs/
        |- extensions/
        |- jre/
        |- lib/
        |- license/
        |- log/
        |- api-doc.zip
        |- changelog.txt
        |- epr_api-2.0.5.zip
        |- examples.zip
        |- known-issues.txt
        |- readme.txt
        |- src.zip
        |- version.txt

The MerisC2R processor plug-in, named 'MerisC2R.jar', must simply be added
to the $BEAM_HOME$/extensions/ subdirectory.
Also its auxdata folder, named 'merisc2r', must be added to the
$BEAM_HOME$/auxdata/ directory. The BEAM application (VISAT)
will automatically integrate the MerisC2R processor within its interface.


Operation
---------

Once the BEAM software and the MerisC2R processor have been installed, the
package can be operated in two different modes: interactive and automatic.

Interactive processing
----------------------
To launch an interactive session, start the main BEAM software application
(VISAT) and select the MerisC2R processor using the following menu selections:

	Tools -> Meris Case-2 Regional Processor.

A dialog window will appear:

At the "I/O Parameters" tab you can specify your input and output product and also
the format of the output. Additionally you can switch on that a log file is created
in the output directory and specify a name prefix for it.

At the "Processing Parameters" tab you can load/save/edit different configurations
of processing parameters.

Automatic (batch-) processing
-----------------------------
To process one or more data sets automatically, i.e., without requiring
manual input, it is also possible to launch the application from the
command line (or an executable script, for that matter).

For convenience we supplied a UNIX script (merisc2r.sh) and a script for Windows
computers (merisc2r.bat) to run the MerisC2R processor in its interactive or
non-interactive (= batch) mode. Also we provide an example processing request
file (merisc2r_request.xml) as a template to use as a starting point from the command line.

Customisation
-------------
First: adapt the variable BEAM_HOME in merisc2r.sh or merisc2r.bat.

Windows example (in merisc2r.bat):
SET BEAM_HOME=C:\beam-3.2

UNIX example (in merisc2r.sh):
BEAM_HOME=/usr/local/bin/beam-3.2

Second: copy the template xml request file and rename it to a processing
request file you need.
Last: adapt the InputProduct and OutputProduct in the processing request
you want to use.
Then this script may be launched from anywhere in the following modes :

Interactive mode :
    unix:    merisc2r.sh -i
    windows: merisc2r.bat -i

Interactive mode with debug info :
    unix:    merisc2r.sh -i -d
    windows: merisc2r.bat -i -d

Interactive mode with predefined request :
    unix:    merisc2r.sh -i /path/to/user_request.xml
    windows: merisc2r.bat -i /path/to/user_request.xml

Batch mode with predefined request :
    unix:    merisc2r.sh /path/to/user_request.xml
    windows: merisc2r.bat /path/to/user_request.xml



Warranties and copyright information
------------------------------------

The MerisC2R processor package described in this document is provided
'as is', with no warranty of merchantability or fitness to any particular
purpose. Although every effort has been made to ensure accuracy of computations
and conformity to the algorithms as published in the references below, the
authors assume no responsibility whatsoever for any direct, indirect or
consequential damage resulting from the use of this software. The MerisC2R
processor is distributed free of charge and cannot be sold or re-sold. It
can be copied and distributed further, provided all documentation is attached
and provided the original source of the software is explicitly and
prominently described.

Questions, concerns and problems should be referred to the authors of the
software package at the address indicated at the start of this file.

The copyright on this file and the associated software remains with the
Brockmann Consult GmbH.