NAME

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

VERSION

version 0.15.0

SYNOPSIS

This program generates a new configuration file from a template, or prints the content of the configuration file found in place, if any.

configuration [-c|--config <file>]

Note that if you provide a different config file, it will be read, but all the programs will still load it from the default location (see below)

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.

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.

EXAMPLE TEMPLATE

# Default configuration file for NBI::Slurm tools
# This file is in key=value format, and can be edited manually.

# Temporary directory 
tmpdir=/tmp

# Email address to use for job submission
email=your.email@domain.com

# When to be notified about job status changes: none, end, fail, all
email_type=end,fail

# Other custom defaults you can set:
# queue=
# time=
# gpuqueue=

# INTERACTIVE SESSION

# A string of parameters to be used for all interactive sessions
# session=

# A string of parameters to be used for interactive sessions when --special is specified
# special_session=--constraint=intel

# Default memory for session
session_memory=2000
session_cpus=2
session_hours=12

# IMAGES FOR HPC

# Default destination when --move an image
default_dest=/qib/platforms/Informatics/transfer/outgoing/singularity/core/

# Where to place the package
packages_dir=/nbi/software/testing/bin/

# Where to place the binaries
packages_basepath=/nbi/software/testing/

AUTHOR

Andrea Telatin <proch@cpan.org>

COPYRIGHT AND LICENSE

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

This is free software, licensed under:

The MIT (X11) License