Installation

This is a getting started guide for using monarch. Note that if you're doing analysis with katydid, monarch is usually built automatically as a submodule and you shouldn't need to do anything manually. From here you can skip ahead to the dependency listing or build instructions.

Dependencies

• git is a version control system. While not strictly required, it is highly recommended.
• cmake (version 2.8 or greater) is a build tool used for monarch. On linux systems you can probably install it from your package manager. It must be installed prior to building monarch.
• protobuf is the data encoding format developed by Google and used by monarch. On linux it is most likely available from your package manager. It must be installed prior to building monarch.
• libthorax is a collection of useful library functions. It is included as a git submodule and under normal circumstances, need not be built separately.

Building

Assuming dependencies are met, the following step-by-step instructions should work on most systems. Quote sections starting with a '$' can generally be pasted directly into a shell (without the leading '$'), required changes will be noted (enclosed with < >). Out-of-source build is recommended, though locating it inside the top level directory of the source tree is supported.

1. Get source from github $ git clone [email protected]:project8/monarch. Optionally you can then switch to a particular tag with $ git checkout <tag-id> where <tag-id> is the tag you'd like to use (checkout must be done after changing into the source directory).
2. Initialize and download the required submodules $ git submodule update --init --recursive should take care of everything.
3. Create a build directory and initialize cmake for it. Assuming you're in the top level source directory, $ mkdir build && cd build && cmake .. will take care of this. If you want to check/change cmake options, you can do that now (```$ ccmake ..`` provides a convenient curses based interface for this).
4. Build and install the source with $ make and $ make install respectively. You can also skip the former and it will build and install all in one go.