Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
nb2slurm 0.1.1
nb2slurm 0.1.1

Getting started

  • Installation
  • Quickstart
  • HPC for notebook users (no Linux required)
  • nb2slurm on Windows: installing WSL

Guide

  • The notebook contract
    • Making your notebooks nb2slurm-compatible
  • jobs.json — jobs and the output tree in one file
  • Environments and kernels
  • Generated files
  • Connecting to the cluster
  • Moving files: push up, pull down
  • Control notebooks
    • Pseudo Code nb2slurm
    • 0. Configure your run
    • 1. Build & push
    • 2. Submit & monitor
    • 3. Sync results back

Examples

  • nb2slurm — how it works (illustrative walkthrough)
  • Monte Carlo π example
    • Example: Monte Carlo Simulation of Pi
    • Monte Carlo π with nb2slurm
    • Step 0 — settings
    • Step 1 — simulate
    • Step 2 — plot
    • Analyse all subsets

Reference

  • API reference
Back to top
Copyright © 2026, Mark Melotto and the eWaterCycle project
Made with Sphinx and @pradyunsg's Furo