Home

The scripts in this repo are used to build docker images from the bbp distribution.

Benefits of BBP Docker

Our SCEC group is using Docker to help distribute our scientific software. Users that retrieve SCEC software from Dockerhub and the software will install and run on a wide variety of computers and operating systems. SCEC software is designed for use on Linux computer environments, becauses most academic HPC clusters are Linux-based systems. The Docker version of BBP will run on Linux, but also on Mac and Windows computers.

BBP Docker User Experience

Configuring to Run BBP Docker

The BBP Docker installation assumes that the bbp software and data separates into two may storage areas:

Installation

Clone the bbp_docker git repo to get scripts used in docker build

On Mac:

$cd /Users/maechlin
$git clone https://github.com/sceccode/bbp_docker.git

cd into new directory

$cd bbp_docker

Retrieve the git repo of the bbp distribution that you want to install in the docker image: Syntax for single branch clone

$git clone --single-branch --branch <branchname> <remote-repo>
$git clone --single-branch --branch dev https://github.com/sceccode/bbp.git

Define Regions of Interest

The BBP platform supports earthquake simulations for multiple regions. Each supported region uses region specific, and method specific, greens functions. During our Docker evaluation, we are working with a minimum installation of BBP. This will include GF for southern California regions, and three validation events, Whittier Narrrows, Northridge, and Chino Hills. If this minimun configuration proves useful, we can configure other regions, or potentially more regions in each image. More regions will increase the size of the Docker image. Current, we expect Docker images of 50GB range, which is substantial. Pulling this image from Dockerhub can take up to one hour.

Retrieve large files

To reduce the Docker build time, we stage several large files in the bbp_docker/ build directory. By staging these files before we run the Docker build, these file are copied into the image during the Docker build process, instead of downloaded over the network.

the staged larges files include:

Anaconda3-2021.05-Linux-x86_64.sh
labasin500-velocity-model-19.4.0.tar.gz
curl -O http://hypocenter.usc.edu/research/bbp/versions/19.4.0/nr-validation-19.4.0.tar.gz
curl -O http://hypocenter.usc.edu/research/bbp/versions/19.4.0/whittier-validation-19.4.0.tar.gz
curl -O http://hypocenter.usc.edu/research/bbp/versions/19.4.0/chino-hills-validation-19.4.0.tar.gz

Start the Docker Build

In this repo, there is a build_bbp.sh script. This invokes the docker build command. This script gives the output image a name (a tag). The current tag convention is bbp_19_4:MMDDHHMM with the assumption that "later" docker images are prefered over earlier ones. This naming convention should be updated to identify what regions and validation events are included in the image.

$build_bbp.sh

This starts the docker build process. The process completes it will create a new image and write it to the docker repo on the current computer.

Push the Image to Dockerhub

On the development computer,

$ docker tag -t sceccode/bbp_19_4:MMDDHHMM
$docker push sceccode/bbp_19_4:MMDDHHMM

Using the Image

This directory contains a script that will run the docker bbp image:

$run_bbp.sh