NAME

configuration_file_info - How to make your configuration file for NBI::Slurm tools

VERSION

version 0.4.13

LOCATION

NBI::Slurm tools use a configuration file to store some default values.

At the moment there is no central use of the file, and it's just provided as a convenient shortcut for some of the options.

The configuration file is located at ~/.nbislurm.config.

# Create a configuration file
$ touch ~/.nbislurm.config

CONFIGURATION

The file is a simple key=value format. The value can contain spaces and even equal signs, as long as the key doesn't.

Configuring jobs

• tmpdir

  Where to store temporary files for jobs. It's is recommended to customize this to store jobs and their logs in a convenient location by default.

• queue

  The default queue to use when submitting jobs.

• time

  The default time to use when submitting jobs, in time string format (see NBI::Opts).

• memory

  The default memory to use when submitting jobs. Recommended to use an integer (MB), but a memory string will also work.

• threads

  The default number of threads to use when submitting jobs.

• email

  The default email address to use when submitting jobs.

• email_type

  When to send emails, default is 'none'.

Interactive Sessions

The session script has two additional options that can be set in the configuration file:

• session

  A string of parameters to be used for all interactive sessions.

• special_session

  A string of parameters to be used for interactive sessions when --special is specified.

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