Installation - RCChan5/BioLockJ GitHub Wiki

First, determine if you need to install BioLockJ. BioLockJ can be used in these environments:

  • a local machine with a unix-like system
  • any machine running docker
  • a cluster, running a scheduler such as torque
  • AWS cloud computing (which uses docker)

BioLockJ can be launched using either the command line interface or the docker-container-hosted user interface. If using docker, you don't need to install BioLockJ, but you do need to install docker. BioLockJ run within the blj_manager container. If you are NOT using docker, or you wish to host BioLockJ on your local machine and only run modules in docker, then you need to actually install docker. This is true for both a local machine or a cluster.

If you are using BioLockJ on a shared system where another user has already installed BioLockJ, you will still need to run the install script to create the required variables in your own user profile.

Install BioLockJ

This requires a unix-like environment.

1. Download & unpack the tarball: BioLockJ-0.9.4-beta

    > tar -zxf BioLockJ-0.9.4-beta

Get the latest release.

Alternatively, you could compile the source code yourself using ant.

2. Run BioLockJ install script

  • The install script updates the $USER bash profile to call blj_config

  • The installation script completes immediately since only 1 line is added to your bash profile.

  • See Commands for a full description of blj_config

      > ./install
      >     Saved backup:  /users/msioda/.bash_profile~
      >     Saved profile:  /users/msioda/.bash_profile
      > BioLockJ installation complete!
    

This will add the required variables to your path when you start your next session. To use BioLockJ in the same session, run source ~/.bash_profile.

3. Install the software Dependencies required by the modules you wish to include in your pipeline.