From dbc5c2caaeb47a2aa984f60098d1deea87636cce Mon Sep 17 00:00:00 2001 From: Matthew Defenderfer <mdefende@uab.edu> Date: Thu, 6 Mar 2025 16:33:00 -0600 Subject: [PATCH] remove all jupyter material from the readme --- README.md | 76 +------------------------------------------------------ 1 file changed, 1 insertion(+), 75 deletions(-) diff --git a/README.md b/README.md index e257575..9890d57 100644 --- a/README.md +++ b/README.md @@ -1,75 +1 @@ -# Batch Connect - JupyterLab - - - - -An example Batch Connect app that launches a JupyterLab 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): - -- [JupyterLab](http://jupyterlab.readthedocs.io/en/latest/) 3.2.1 (earlier - versions are untested but may work for you) -- [OpenSSL](https://www.openssl.org/) 1.0.1+ (used to hash the JupyterLab - server password) - -**Optional** software: - -- [Lmod](https://www.tacc.utexas.edu/research-development/tacc-projects/lmod) - 6.0.1+ or any other `module purge` and `module load <modules>` based CLI - used to load appropriate environments within the batch job before launching - the JupyterLab. - -## 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. - -```sh -# Download the zip from the GitHub page -wget https://github.com/uabrc/ood_jupyterlab/archive/master.tar.gz - -# Create a catchy directory -mkdir my_jupyterlab_app - -# Unzip the downloaded file into this directory -tar xzvf master.tar.gz -C my_jupyterlab_app --strip-components=1 - -# Change the working directory to this new directory -cd my_jupyterlab_app -``` - -From here you will make any modifications to the code that you would like and -version your changes in your own repository: - -```sh -# 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 +# Batch Connect - PyCharm -- GitLab