diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 38491a6..99e78c8 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -23,6 +23,7 @@ - [Interactive Jupyter Notebook](running_jupyter.md) - [Install conda environment](conda_env.md) - [Running Singularity](Singularity.md) + - [Running Interactive Jobs](interact_job.md) - Off-Campus Cluster - [External Computation resources](additional.md) - [HPC@UC](hpc_uc.md) diff --git a/docs/interact_job.md b/docs/interact_job.md new file mode 100644 index 0000000..8a2f584 --- /dev/null +++ b/docs/interact_job.md @@ -0,0 +1,61 @@ +# Interactive Jobs + +Interactive jobs are a useful way to debug and test code with small sample inputs before submitting scaled up input in a batch job. Interactive jobs allows users to allocate resources and work on a node directly, seeing any errors or outputs in real-time as the program runs. + +Interactive jobs can be observed as a two-part process: +1. Requesting the resources. +2. Entering the requested resources to run programs. + +Below will be a demonstration about running an interactive job + +## Requesting an Interactive Job + +To start an interactive session: the `salloc` command allocates resources for the interactive job. Once the resources are allocated the `srun` command will be used to enter the compute node configured for the interactive node. + +`salloc` comamnd template: + salloc --partition= --nodes=<#> --ntasks-per-node=<#> --time=