NAME

session - Start an interactive session on the cluster

VERSION

version 0.8.2

SYNOPSIS

  session [options]
  
  Options:
    -c  --threads   Number of CPU cores (default: 1)
    -m  --mem       Memory size in MB (default: 1000)
    -h  --hours     Number of hours (default: 4)
    -d  --days      Number of days (added to hours)
    -n  --name      Job name (default: session)
    -q  --queue     Queue/partition name (default: determined by hours)
    -s  --special   Enable the special parameter string from the config file (default: off)
    -i  --intel     Use Intel constraint (default: off)

DESCRIPTION

The session script allows you to start an interactive session on the cluster with customizable options.

OPTIONS

-c, --threads INT

Number of CPU cores. By default, it is set to 1.

-m, --mem STRING|INT

Memory size. If an integer is given, it's used as memory in MB. Specify "dddGB" to set memory in GB. By default it is set to 1000, which is 1GB. If a number <=200 is provided, it will be used as GB.

-h, --hours INT

Number of hours. By default, it is set to 4.

-d, --days INT

Number of days. Default is 0, and can be omitted (hours will update the days)

-n, --name STRING

Job name. By default, it is set to "session".

-q, --queue STRING

Queue/partition name.

-s, --special

Enable the special parameter string from the config file (default: off). See the CONFIGURATION section below.

-i, --intel

Use Intel constraint. By default, it is turned off.

EXAMPLES

Start an interactive session with 2 CPU cores, 2000 MB of memory, and 8 hours:

  session -c 2 -m 2GB -h 8

Start an interactive session with the default settings:

  session

CONFIGURATION

In your ~/.nbislurm.config file, you can set two session-specific options:

  default_session=STRING
  special_session=STRING

The command to start the session will always include the default_session option.

If you want to start a session with the special_session option, you can use the --special option:

  session --special

Consider that the --intel switch is a special case of adding the --constraint=intel option to the command.

AUTHOR

Andrea Telatin <proch@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2023 by Andrea Telatin.

This is free software, licensed under:

  The MIT (X11) License