README.firstbooks.md

This README is specific to FirstBooks project.

Table of Contents

1. Install
2. Build
3. Setup
4. Usage
5. Support
6. Development

Install

Clone this repository and merge in the submodules

git clone https://github.com/Early-Modern-OCR/emop-controller.git
cd emop-controller

Copy the modulefiles.example directory to modulefiles and set the firstbooks module to be loaded as the emop module.

cp -r modulefiles.example modulefiles
cp modulefiles/firstbooks.lua modulefiles/emop.lua

Build

1. Load emop module.

    module use ./modulefiles
    module load emop
   

2. Build and install Ocular.

    make ocular
   

Setup

For multiple users to run this controller on the same file structure the umask must be set to at least 002.

Add the following to your login scripts such as ~/.bashrc

umask 002

Rename the following configuration files and change their values as needed:

• config.ini.example-firstbooks to config.ini

The file config.ini contains all the configuration options used by the emop-controller.

Usage

See README

Development

System tests

Verify transfers can be initiated and possibly update config to appropriate values

./emopcmd.py -c tests/system/config-firstbooks-test.ini transfer status

To run the test using stakeholder or stakeholder-4g partition:

sbatch -p stakeholder,stakeholder-4g tests/system/firstbooks-test.slrm

Check the output of logs/test/emop-controller-test-JOBID.out where JOBID is the value output when sbatch was executed.