Skip to content
Snippets Groups Projects
Forked from rc / bc_uab_jupyter
41 commits behind the upstream repository.
user avatar
Eric Franz authored
the only benefit of specifying the title in the form.yml is when we have
"subapps", where each subapp needs a different title; otherwise the manifest.yml can be used

this way we can maintain for all our apps that the basic way you change the title of the app
is to specify name in the manifest
42ef6900

Batch Connect - Example Jupyter Notebook Server

GitHub Release GitHub License

An example Batch Connect app that launches a Jupyter Notebook server within a batch job.

Prerequisites

This Batch Connect app requires the following software be installed on the compute nodes that the batch job is intended to run on (NOT the OnDemand node):

  • Jupyter Notebook 4.2.3+ (earlier versions are untested but may work for you)
  • OpenSSL 1.0.1+ (used to hash the Jupyter Notebook server password)

Optional software:

  • Anaconda 4.3.13+ and its Jupyter Notebook extensions that allow users to define custom environment-based kernels from within the Jupyter notebook dashboard.
  • Lmod 6.0.1+ or any other module restore and module load <modules> based CLI used to load appropriate environments within the batch job before launching the Jupyter Notebook server.

Install

These are command line only installation directions.

We start by downloading a zipped package of this code. This allows us to start with a fresh directory that has no git history as we will be building off of this.

# Download the zip from the GitHub page
wget https://github.com/OSC/bc_example_jupyter/archive/master.tar.gz

# Create a catchy directory
mkdir my_jupyter_app

# Unzip the downloaded file into this directory
tar xzvf master.tar.gz -C my_jupyter_app --strip-components=1

# Change the working directory to this new directory
cd my_jupyter_app

From here you will make any modifications to the code that you would like and version your changes in your own repository:

# Version our app by making a new Git repository
git init

#
# Make all your code changes while testing them in the OnDemand Dashboard
#
# ...
#

# Add the files to the Git repository
git add --all

# Commit the staged files to the Git repository
git commit -m "my first commit"

Contributing

  1. Fork it ( https://github.com/OSC/bc_example_jupyter/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request