quick-start.html


<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
      
      <link rel="icon" href="assets/images/favicon.png">
      <meta name="generator" content="mkdocs-1.1, mkdocs-material-7.1.0">
    
    
        <title>Quick Start - HPC Documentation</title>
      
    
      <link rel="stylesheet" href="assets/stylesheets/main.33e2939f.min.css">
      
        
        <link rel="stylesheet" href="assets/stylesheets/palette.ef6f36e2.min.css">
        
      
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
        <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
      
    
      <link rel="stylesheet" href="stylesheets/unibe.css">
    
    
  </head>
  
  
    <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  
    
    <script>function __prefix(e){return new URL(".",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
        
        <a href="#quick-start" class="md-skip">
          Skip to content
        </a>
      
    </div>
    <div data-md-component="announce">
      
    </div>
    
      <header class="md-header" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
    <a href="." title="HPC Documentation" class="md-header__button md-logo" aria-label="HPC Documentation" data-md-component="logo">
      
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>

    </a>
    <label class="md-header__button md-icon" for="__drawer">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
    </label>
    <div class="md-header__title" data-md-component="header-title">
      <div class="md-header__ellipsis">
        <div class="md-header__topic">
          <span class="md-ellipsis">
            HPC Documentation
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              Quick Start
            
          </span>
        </div>
      </div>
    </div>
    
    
      <label class="md-header__button md-icon" for="__search">
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
      </label>
      
<div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
      <label class="md-search__icon md-icon" for="__search">
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
      </label>
      <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
      </button>
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
    
    
      <div class="md-header__source">
        
<a href="https://github.com/hpc-unibe-ch/hpc-docs" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  </div>
  <div class="md-source__repository">
    hpc-unibe-ch/hpc-docs
  </div>
</a>
      </div>
    
  </nav>
</header>
    
    <div class="md-container" data-md-component="container">
      
      
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href="." title="HPC Documentation" class="md-nav__button md-logo" aria-label="HPC Documentation" data-md-component="logo">
      
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>

    </a>
    HPC Documentation
  </label>
  
    <div class="md-nav__source">
      
<a href="https://github.com/hpc-unibe-ch/hpc-docs" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  </div>
  <div class="md-source__repository">
    hpc-unibe-ch/hpc-docs
  </div>
</a>
    </div>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
    <li class="md-nav__item">
      <a href="general/news.html" class="md-nav__link">
        News
      </a>
    </li>
  

    <li class="md-nav__item md-nav__item--active">
      
      <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
      
        
        <label class="md-nav__link md-nav__link--active" for="__toc">
          Quick Start
          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <a href="quick-start.html" class="md-nav__link md-nav__link--active">
        Quick Start
      </a>
      
        
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#cluster-rules" class="md-nav__link">
    Cluster Rules
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#request-an-account" class="md-nav__link">
    Request an Account
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#hpc-workspace" class="md-nav__link">
    HPC Workspace
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#login" class="md-nav__link">
    Login
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#welcome-home" class="md-nav__link">
    Welcome $HOME
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#copy-data" class="md-nav__link">
    Copy Data
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#use-software" class="md-nav__link">
    Use Software
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#hello-world" class="md-nav__link">
    Hello World
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#schedule-your-job" class="md-nav__link">
    Schedule Your Job
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#monitor-your-job" class="md-nav__link">
    Monitor Your Job
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#training-courses" class="md-nav__link">
    Training Courses
  </a>
  
</li>
      
    </ul>
  
</nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
      
        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
      
      <label class="md-nav__link" for="__nav_3">
        Getting Started
        <span class="md-nav__icon md-icon"></span>
      </label>
      <nav class="md-nav" aria-label="Getting Started" data-md-level="1">
        <label class="md-nav__title" for="__nav_3">
          <span class="md-nav__icon md-icon"></span>
          Getting Started
        </label>
        <ul class="md-nav__list" data-md-scrollfix>
          
            
    <li class="md-nav__item">
      <a href="code-of-conduct.html" class="md-nav__link">
        Code of Conduct
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="getting-Started/ubelix-overview.html" class="md-nav__link">
        UniBE HPC system "UBELIX"
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="getting-Started/account.html" class="md-nav__link">
        Accounts and Activation
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="getting-Started/#-ssh.html" class="md-nav__link">
        Accessing the HPCs
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="getting-Started/workspaces.html" class="md-nav__link">
        Workspaces
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="getting-Started/ssh-customization.html" class="md-nav__link">
        SSH customization
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="getting-Started/shell.html" class="md-nav__link">
        Shell customization
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="getting-Started/parallelization.html" class="md-nav__link">
        Parallelization
      </a>
    </li>
  

        </ul>
      </nav>
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
      
        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
      
      <label class="md-nav__link" for="__nav_4">
        Workspaces
        <span class="md-nav__icon md-icon"></span>
      </label>
      <nav class="md-nav" aria-label="Workspaces" data-md-level="1">
        <label class="md-nav__title" for="__nav_4">
          <span class="md-nav__icon md-icon"></span>
          Workspaces
        </label>
        <ul class="md-nav__list" data-md-scrollfix>
          
            
    <li class="md-nav__item">
      <a href="hpc-workspaces/workspaces.html" class="md-nav__link">
        Overview
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="hpc-workspaces/management.html" class="md-nav__link">
        Workspace management
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="hpc-workspaces/environment.html" class="md-nav__link">
        Software environment
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="hpc-workspaces/monitoring.html" class="md-nav__link">
        Monitoring
      </a>
    </li>
  

        </ul>
      </nav>
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
      
        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
      
      <label class="md-nav__link" for="__nav_5">
        SLURM / Job handling
        <span class="md-nav__icon md-icon"></span>
      </label>
      <nav class="md-nav" aria-label="SLURM / Job handling" data-md-level="1">
        <label class="md-nav__title" for="__nav_5">
          <span class="md-nav__icon md-icon"></span>
          SLURM / Job handling
        </label>
        <ul class="md-nav__list" data-md-scrollfix>
          
            
    <li class="md-nav__item">
      <a href="slurm/partitions.html" class="md-nav__link">
        Partitions / QoS
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="slurm/submission.html" class="md-nav__link">
        Submitting jobs
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="slurm/monitoring-jobs.html" class="md-nav__link">
        Monitoring Jobs
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="slurm/deleting-jobs.html" class="md-nav__link">
        Deleting Jobs
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="slurm/array-jobs.html" class="md-nav__link">
        Array Jobs with Slurm
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="slurm/dependencies.html" class="md-nav__link">
        Job dependencies
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="slurm/gpus.html" class="md-nav__link">
        GPUs
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="slurm/interactive-jobs.html" class="md-nav__link">
        Interactive Jobs
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="slurm/investigating-job-failure.html" class="md-nav__link">
        Investigating a Job Failure
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="slurm/checkpointing.html" class="md-nav__link">
        Checkpointing
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="slurm/fair-share.html" class="md-nav__link">
        Fair Share
      </a>
    </li>
  

        </ul>
      </nav>
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
      
        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
      
      <label class="md-nav__link" for="__nav_6">
        Software
        <span class="md-nav__icon md-icon"></span>
      </label>
      <nav class="md-nav" aria-label="Software" data-md-level="1">
        <label class="md-nav__title" for="__nav_6">
          <span class="md-nav__icon md-icon"></span>
          Software
        </label>
        <ul class="md-nav__list" data-md-scrollfix>
          
            
    <li class="md-nav__item">
      <a href="software/hpc-modules.html" class="md-nav__link">
        HPC software environment
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/installing-custom-software.html" class="md-nav__link">
        Installing Custom Software
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/EasyBuild.html" class="md-nav__link">
        EasyBuild
      </a>
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
      
        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
      
      <label class="md-nav__link" for="__nav_6_4">
        Supported Applications
        <span class="md-nav__icon md-icon"></span>
      </label>
      <nav class="md-nav" aria-label="Supported Applications" data-md-level="2">
        <label class="md-nav__title" for="__nav_6_4">
          <span class="md-nav__icon md-icon"></span>
          Supported Applications
        </label>
        <ul class="md-nav__list" data-md-scrollfix>
          
            
    <li class="md-nav__item">
      <a href="software/Anaconda.html" class="md-nav__link">
        Anaconda
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/CUDA.html" class="md-nav__link">
        CUDA
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/JupyterLab.html" class="md-nav__link">
        JupyterLab
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/matlab.html" class="md-nav__link">
        Matlab
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/bzip2.html" class="md-nav__link">
        Parallel BZIP2
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/ParaView.html" class="md-nav__link">
        ParaView
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/python.html" class="md-nav__link">
        Python
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/r.html" class="md-nav__link">
        R
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/relion.html" class="md-nav__link">
        Relion
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/singularity.html" class="md-nav__link">
        Singularity
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="software/terminal-multiplexer-tmux.html" class="md-nav__link">
        Terminal Multiplexer (tmux)
      </a>
    </li>
  

        </ul>
      </nav>
    </li>
  

        </ul>
      </nav>
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
      
        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
      
      <label class="md-nav__link" for="__nav_7">
        Storage
        <span class="md-nav__icon md-icon"></span>
      </label>
      <nav class="md-nav" aria-label="Storage" data-md-level="1">
        <label class="md-nav__title" for="__nav_7">
          <span class="md-nav__icon md-icon"></span>
          Storage
        </label>
        <ul class="md-nav__list" data-md-scrollfix>
          
            
    <li class="md-nav__item">
      <a href="file-system/filesystem-overview.html" class="md-nav__link">
        Overview
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="file-system/quota.html" class="md-nav__link">
        Quota
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="file-system/file-transfer.html" class="md-nav__link">
        Moving files to and from the HPCs
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="file-system/scratch.html" class="md-nav__link">
        Scratch
      </a>
    </li>
  

        </ul>
      </nav>
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
      
        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
      
      <label class="md-nav__link" for="__nav_8">
        Optimization
        <span class="md-nav__icon md-icon"></span>
      </label>
      <nav class="md-nav" aria-label="Optimization" data-md-level="1">
        <label class="md-nav__title" for="__nav_8">
          <span class="md-nav__icon md-icon"></span>
          Optimization
        </label>
        <ul class="md-nav__list" data-md-scrollfix>
          
            
    <li class="md-nav__item">
      <a href="optimization/scaling.html" class="md-nav__link">
        Scaling
      </a>
    </li>
  

        </ul>
      </nav>
    </li>
  

    <li class="md-nav__item">
      <a href="general/investment.html" class="md-nav__link">
        Investment
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="general/support.html" class="md-nav__link">
        Support
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="general/faq.html" class="md-nav__link">
        FAQ
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="halloffame.html" class="md-nav__link">
        Hall of Fame
      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="code-of-conduct.html" class="md-nav__link">
        Code of Conduct
      </a>
    </li>
  

  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#cluster-rules" class="md-nav__link">
    Cluster Rules
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#request-an-account" class="md-nav__link">
    Request an Account
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#hpc-workspace" class="md-nav__link">
    HPC Workspace
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#login" class="md-nav__link">
    Login
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#welcome-home" class="md-nav__link">
    Welcome $HOME
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#copy-data" class="md-nav__link">
    Copy Data
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#use-software" class="md-nav__link">
    Use Software
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#hello-world" class="md-nav__link">
    Hello World
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#schedule-your-job" class="md-nav__link">
    Schedule Your Job
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#monitor-your-job" class="md-nav__link">
    Monitor Your Job
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#training-courses" class="md-nav__link">
    Training Courses
  </a>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          <div class="md-content" data-md-component="content">
            <article class="md-content__inner md-typeset">
              
                
                <h1 id="quick-start">Quick Start</h1>
<p>This section is intended as a brief introduction into HPC, especially to the present system UBELIX. 
This page is an summary, a hands-on introduction, which targets primarily users without prior knowledge in high-performance computing. However, basic Linux knowledge is a prerequisite. If you are not familiar with basic Linux commands, there are many beginner tutorials available online. 
After reading this page you will have composed and submitted your first job successfully to the cluster. Links are provided throughout the text to point you to more in-depth information on the topic.</p>
<h2 id="cluster-rules">Cluster Rules</h2>
<p>Before we start: as everywhere where people come together, a <strong>common sense</strong> is needed to allow for a good cooperation and to enable a positive HPC experience. Be always aware that you are working on a <strong>shared system</strong> where your behaviour could have a negative impact on the workflow of other users. Please find the list of the most important guidelines in our <a href="code-of-conduct.html"><strong>code of conduct</strong></a>.</p>
<h2 id="request-an-account">Request an Account</h2>
<p>Before you can start working on the HPCs, staff and students of the University of Bern must have their <strong>Campus Account (CA)</strong> registered for the HPCs. External researchers that collaborate with an institute of the University of Bern must apply for a CA through that institute. See <a href="getting-Started/account.html">Accounts and Activation</a> for more information getting access to UBELIX.</p>
<h2 id="hpc-workspace">HPC Workspace</h2>
<p>Workspaces provide are a collaborative environment, including group based access to permanent and temporary storage, as well as group based compute resource accounting. 
Research group leaders need to apply for an workspace, see <a href="hpc-workspaces/management.html">Workspace Management</a>. 
For an introduction to HPC Workspaces see <a href="hpc-workspaces/workspaces.html">Workspace Overview</a></p>
<h2 id="login">Login</h2>
<p>To connect to the cluster, you must log in to the <strong>submit host</strong> from <strong>inside the university network</strong> (e.g. from a workstation on the campus). If you want to connect from a remote location (e.g. from your computer at home) you must first establish a <strong>VPN</strong> connection to get access to the university network. To connect from a UNIX-like system (Linux, Mac OS X, MobaXterm on Windows) simply use a secure shell (SSH) to log in to the submit host:</p>
<div class="highlight"><pre><span></span><code>ssh &lt;username&gt;@submit.unibe.ch
<span class="c1"># the following is equivalent</span>
ssh -l &lt;username&gt; submit.unibe.ch
</code></pre></div>

<h2 id="welcome-home">Welcome <code>$HOME</code></h2>
<p>After successful login to the cluster, your will find yourself in the directory <code>/storage/homefs/$USER</code>, where <code>$USER</code> is your Campus Account username.
This is your home directory and serves as the repository for your personal files, and configurations. 
You can reference your home directory by <code>~</code> or <code>$HOME</code>. </p>
<p>Your home directory is located on a shared file system. Therefore, all files and directories are always available on all cluster nodes and must hence not be copied between those nodes. HOME directories have a daily snapshot and backup procedures.
Disk space is managed by <a href="file-system/quota.html">quotas</a>. By default, each user has 1TB of disk space available. Keep your home directory clean by regularly deleting old data or by moving data to a private storage.</p>
<p>You can always print the current working directory using the <code>pwd</code> (present working directory) command:
<div class="highlight"><pre><span></span><code><span class="nb">pwd</span>
/storage/homefs/&lt;username&gt;
</code></pre></div></p>
<h2 id="copy-data">Copy Data</h2>
<p>At some point, you will probably need to copy files between your local computer and the cluster. There are different ways to achieve this, depending on your local operating system (OS). To copy a file <strong>from your local computer</strong> running a UNIX-like OS use the secure copy command <code>scp</code> on your local workstation:</p>
<div class="highlight"><pre><span></span><code>scp /path/to/file &lt;username&gt;@submit.unibe.ch:/path/to/target_dir/
</code></pre></div>

<p>To copy a file from the cluster to your local computer running a UNIX-like OS also use the secure copy command <code>scp</code> on your local workstation:</p>
<div class="highlight"><pre><span></span><code>scp &lt;username&gt;@submit.unibe.ch:/path/to/file /path/to/target_dir/
</code></pre></div>

<p>More information about file transfer can be found on the page <a href="file-system/file-transfer.html">File Transfer to/from UBELIX</a>.</p>
<h2 id="use-software">Use Software</h2>
<p>On our HPCs you can make use of already pre-installed software or you can compile and install your own software. We use a module system to manage software packages, even different versions of the same software. This allows you to focus on getting your work done instead of compiling software. E.g. to get a list of all provided packages:</p>
<div class="highlight"><pre><span></span><code>module avail
</code></pre></div>

<p>A package name can be added to list all packages containing that string. </p>
<p>The <code>module spider</code> command encountering also results from the VitalIT software stack. </p>
<div class="admonition type info">
<p class="admonition-title">Workspace software stacks</p>
<p><code>module spider</code> or <code>module avail</code> will only find packages in a Workspace software stack if the <code>Workspace</code> module for that workspace is loaded</p>
</div>
<p>Furthermore, we are suggesting to work with so called toolchains. These are collections of modules build on top of each other. 
E.g. setting the environment for compiling an scientific application with math. libraries, OpenMPI and GCC, load:</p>
<div class="highlight"><pre><span></span><code>$ module load foss
$ module list 
module list

Currently Loaded Modules:
  <span class="m">1</span><span class="o">)</span> GCCcore/9.3.0                      <span class="m">4</span><span class="o">)</span> GCC/9.3.0                          <span class="m">7</span><span class="o">)</span> libxml2/.2.9.10-GCCcore-9.3.0    <span class="o">(</span>H<span class="o">)</span>  <span class="m">10</span><span class="o">)</span> UCX/1.8.0-GCCcore-9.3.0   <span class="m">13</span><span class="o">)</span> gompi/2020a                  <span class="m">16</span><span class="o">)</span> foss/2020a
  <span class="m">2</span><span class="o">)</span> zlib/.1.2.11-GCCcore-9.3.0   <span class="o">(</span>H<span class="o">)</span>   <span class="m">5</span><span class="o">)</span> numactl/2.0.13-GCCcore-9.3.0       <span class="m">8</span><span class="o">)</span> libpciaccess/.0.16-GCCcore-9.3.0 <span class="o">(</span>H<span class="o">)</span>  <span class="m">11</span><span class="o">)</span> OpenMPI/4.0.3-GCC-9.3.0   <span class="m">14</span><span class="o">)</span> FFTW/3.3.8-gompi-2020a
  <span class="m">3</span><span class="o">)</span> binutils/.2.34-GCCcore-9.3.0 <span class="o">(</span>H<span class="o">)</span>   <span class="m">6</span><span class="o">)</span> XZ/.5.2.5-GCCcore-9.3.0      <span class="o">(</span>H<span class="o">)</span>   <span class="m">9</span><span class="o">)</span> hwloc/2.2.0-GCCcore-9.3.0             <span class="m">12</span><span class="o">)</span> OpenBLAS/0.3.9-GCC-9.3.0  <span class="m">15</span><span class="o">)</span> ScaLAPACK/2.1.0-gompi-2020a

  Where:
   H:  Hidden Module
</code></pre></div>

<p>You can also specify version numbers there. </p>
<div class="admonition attention">
<p class="admonition-title">Scope</p>
<p>The loaded version of a software is only active in your current session. If you open a new shell you are again using the default version of the software. Therefore, it is crucial to load the required modules from within your job script.</p>
<p>But also keep in mind that the current environment will get forwarded into a job submitted from it. This may lead to conflicting versions of loaded modules and modules loaded in the script. </p>
</div>
<p>With the module environment you can also easily install, maintain and provide software packages in your workspaces and share with your collaborators. </p>
<p>The <a href="software/hpc-modules.html">Software</a> section is dedicated to this topic. More information can be found there.</p>
<div class="admonition type notes">
<p>Managing different working environments can be done with &ldquo;Meta Modules&rdquo; or user collections, see <a href="software/hpc-modules.html#environment-definitions">Environment Definitions</a></p>
</div>
<h2 id="hello-world">Hello World</h2>
<p>Doing useful computations consists of running commands that work on data and generate a result. These computations are resource-intensive. That is what
the compute nodes are there for. These over 300 servers do the heavy lifting as soon as resources are free for you. Currently you are on a submit server
also known as login server. This server is for preparing the computations, i.e. downloading data, writing a job script, prepare some data etc. But
<strong>you mustn&rsquo;t run computations on submit nodes</strong> as the server is quite a weak machines that you are sharing with others. So, you have to bring the
computations to the compute nodes - by generating a job script and sending it to the cluster.</p>
<div class="admonition hint">
<p class="admonition-title">Working interactively on a compute node</p>
<p>When developing stuff it&rsquo;s often useful to have short iterations of try-error. Therefore it&rsquo;s also possible to work
interactively on a compute node for a certain amount of time without having to send jobs to the cluster and wait until
they finish just to see it didn&rsquo;t work. See <a href="slurm/interactive-jobs.html">Interactive Jobs</a> for more information about this topic.</p>
</div>
<p>It&rsquo;s now time for your first job script. To do some work on the cluster, you require certain resources (e.g. CPUs and memory) and a description of the computations to be done. A job consists of instructions to the scheduler in the form of option flags, and statements that describe the actual tasks. Let&rsquo;s start with the instructions to the scheduler:</p>
<div class="highlight"><pre><span></span><code><span class="ch">#!/bin/bash</span>
<span class="c1">#SBATCH --ntasks=1</span>
<span class="c1">#SBATCH --cpus-per-task=1</span>
<span class="c1">#SBATCH --mem-per-cpu=1GB</span>

<span class="c1"># Put your code below this line</span>
...
</code></pre></div>

<p>The first line makes sure that the file is executed using the bash shell. The remaining lines are option flags used by the <code>sbatch</code> command. The page <a href="slurm/submission.html">Jobs Submission</a> outlines the most important options of <code>sbatch</code>.</p>
<p>Now, let&rsquo;s write a simple &ldquo;hello, world&rdquo;-task:</p>
<div class="highlight"><pre><span></span><code>...
<span class="c1"># Put your code below this line</span>
module load Workspace_Home
mkdir -p <span class="nv">$SCRATCH</span>/my_first_job
<span class="nb">cd</span> <span class="nv">$SCRATCH</span>/my_first_job
<span class="nb">echo</span> <span class="s2">&quot;Hello, UBELIX from node </span><span class="k">$(</span>hostname<span class="k">)</span><span class="s2">&quot;</span> &gt; hello.txt
</code></pre></div>

<p>After loading the Workspace module, we create a new directory &lsquo;my_first_job&rsquo; within our &ldquo;personal&rdquo; SCRATCH directory. The variable <strong><code>$SCRATCH</code></strong> expands to <code>/storage/scratch/users/&lt;your_username&gt;</code>. Then, we change directory to the newly created directory. In the third line we print the line <code>Hello, Ubelix from node &lt;hostname_of_the_executing_node&gt;</code> and redirect the output to a file named <code>hello.txt</code>. The expression <code>$(hostname)</code> means, run the command hostname and put its output here. Save the content to a file named <code>first.sh</code>.</p>
<p>The complete job script looks like this:</p>
<div class="highlight"><pre><span></span><code><span class="ch">#!/bin/bash</span>
<span class="c1">#SBATCH --ntasks=1</span>
<span class="c1">#SBATCH --cpus-per-task=1</span>
<span class="c1">#SBATCH --mem-per-cpu=1GB</span>

<span class="c1"># Put your code below this line</span>
module load Workspace_Home
mkdir -p <span class="nv">$SCRATCH</span>/my_first_job
<span class="nb">cd</span> <span class="nv">$SCRATCH</span>/my_first_job
<span class="nb">echo</span> <span class="s2">&quot;Hello, UBELIX from node </span><span class="k">$(</span>hostname<span class="k">)</span><span class="s2">&quot;</span> &gt; hello.txt
</code></pre></div>

<h2 id="schedule-your-job">Schedule Your Job</h2>
<p>We can now submit our first job to the scheduler. The scheduler will then provide the requested resources to the job. If all requested resources are already available, then your job can start immediately. Otherwise your job will wait until enough resources are available. We submit our job to the scheduler using the <code>sbatch</code> command:</p>
<p><div class="highlight"><pre><span></span><code>sbatch first.sh
</code></pre></div>
<div class="highlight"><pre><span></span><code>Submitted batch job <span class="m">32490640</span>
</code></pre></div>
If the job is submitted successfully, the command outputs a job-ID with which you can refer to your job later on.
There are various options for different types of jobs provided in the scheduler. See sections <a href="slurm/array-jobs.html">Array Jobs</a>, <a href="slurm/gpus.html">GPUs</a>, and <a href="slurm/interactive-jobs.html">Interactive Jobs</a> for more information</p>
<h2 id="monitor-your-job">Monitor Your Job</h2>
<p>You can inspect the state of our active jobs (running or pending) with the squeue command:</p>
<p><div class="highlight"><pre><span></span><code>squeue --job<span class="o">=</span><span class="m">32490640</span>
</code></pre></div>
<div class="highlight"><pre><span></span><code>      JOBID PARTITION     NAME     USER ST       TIME  NODES NODELIST(REASON)
   32490640     epyc2    job01 testuser  R       0:22      1 bnode23
</code></pre></div></p>
<p>Here you can see that the job &lsquo;job01&rsquo; with job-ID 32490640 is in state RUNNING (R).
The job is running in the &lsquo;epyc2&rsquo; partition (default partition) on bnode23 for 22 seconds.
It is also possible that the job can not start immediately after submitting it to SLURM
because the requested resources are not yet available. In this case, the output could
look like this:</p>
<p><div class="highlight"><pre><span></span><code>squeue --job<span class="o">=</span><span class="m">32490640</span>
</code></pre></div>
<div class="highlight"><pre><span></span><code>       JOBID PARTITION     NAME     USER ST       TIME  NODES NODELIST(REASON)
    32490640     epyc2    job01 testuser PD       0:00      1 (Priority)
</code></pre></div></p>
<p>Here you can see that the job is in state PENDING (PD) and a reason why the job
is pending. In this example, the job has to wait for at least one other job with higher priority. See here for a list of other reasons why a job might be pending.</p>
<p>You can always list all your active (pending or running) jobs with squeue:</p>
<p><div class="highlight"><pre><span></span><code>squeue --user<span class="o">=</span>testuser
</code></pre></div>
<div class="highlight"><pre><span></span><code>      JOBID PARTITION     NAME     USER ST       TIME  NODES NODELIST(REASON)
   34651451     epyc2 slurm.sh  testuser PD       0:00      2 (Priority)
   34651453     epyc2 slurm.sh  testuser PD       0:00      2 (Priority)
   29143227     epyc2     Rjob  testuser PD       0:00      4 (JobHeldUser)
   37856328       bdw   mpi.sh  testuser  R       4:38      2 anode[012-014]
   32634559       bdw  fast.sh  testuser  R    2:52:37      1 anode12
   32634558       bdw  fast.sh  testuser  R    3:00:54      1 anode14
   32634554       bdw  fast.sh  testuser  R    4:11:26      1 anode08
   32633556       bdw  fast.sh  testuser  R    4:36:10      1 anode08
</code></pre></div></p>
<p>Further information on on job monitoring you find on page <a href="slurm/monitoring-jobs.html">Monitoring Jobs</a>. Furthermore, in the <em>Job handling</em> section you find additional information about <a href="slurm/investigating-job-failure.html">Investigating a Job Failure</a> and <a href="slurm/checkpointing.html">Check-pointing</a>. </p>
<h2 id="training-courses">Training Courses</h2>
<p><a href="http://www.scits.unibe.ch">Science IT Support (ScITS)</a> regularly conducts introductory and advanced courses on Linux, UBELIX and other topics. Details outlined on <a href="http://www.scits.unibe.ch/training">their pages</a>.</p>
                
              
            </article>
          </div>
        </div>
        
      </main>
      
        
<footer class="md-footer">
  
    <nav class="md-footer__inner md-grid" aria-label="Footer">
      
        <a href="general/news.html" class="md-footer__link md-footer__link--prev" rel="prev">
          <div class="md-footer__button md-icon">
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
          </div>
          <div class="md-footer__title">
            <div class="md-ellipsis">
              <span class="md-footer__direction">
                Previous
              </span>
              News
            </div>
          </div>
        </a>
      
      
        <a href="code-of-conduct.html" class="md-footer__link md-footer__link--next" rel="next">
          <div class="md-footer__title">
            <div class="md-ellipsis">
              <span class="md-footer__direction">
                Next
              </span>
              Code of Conduct
            </div>
          </div>
          <div class="md-footer__button md-icon">
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
          </div>
        </a>
      
    </nav>
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-footer-copyright">
        
          <div class="md-footer-copyright__highlight">
            Copyright &copy; University of Bern, IT Service Office
          </div>
        
        Made with
        <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
          Material for MkDocs
        </a>
        
      </div>
      
  <div class="md-footer-social">
    
      
      <a href="https://github.com/hpc-unibe-ch" target="_blank" rel="noopener" title="github.com" class="md-footer-social__link">
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 480 512"><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg>
      </a>
    
  </div>

    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    <script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "assets/javascripts/workers/search.fe42c31b.min.js", "version": null}</script>
    
    
      <script src="assets/javascripts/bundle.d892486b.min.js"></script>
      
    
  </body>
</html>