Machines Module

nexus.machines.our_load_source(modname, filename)

“ Replacement for the deprecated imp.load_source function

nexus.machines.get_cpu_cores() → int

Get the number of physical CPU cores, defaulting to logical if not available.

This function makes calls to lscpu on Linux and sysctl on MacOS. If these commands fail, it will default to os.cpu_count, which returns the number of logical processors in the system. This may be up to twice as much as the number of physical cores.

class nexus.machines.Options(**kwargs)

Bases: DevBase

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
error(message[, header, exit, trace])	Report an error inside a class.
first()
keys()
list(*keys)
open_log(filepath)
save([fpath])
sorted_keys()
warn(msg[, indent])	Warning from inside a Nexus class.

add
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
extract
extract_optional
get
get_optional
get_path
get_required
inverse
items
last
list_optional
load
log
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
random_key
read
select_random
serial
set
set_optional
set_path
shallow_copy
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
values
write

add(**kwargs)

read(options)

write()

class nexus.machines.Job(**kwargs)

Bases: NexusCore

Attributes:

machine

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
determine_end_status(status)
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
initialize(sim)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
process_options([machine])
reenter_queue()
renew_app_command(sim)
save([fpath])
set_processes()
sorted_keys()
submit()
warn(msg[, indent])	Warning from inside a Nexus class.
write([file])

add
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
clone
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
divert_out_err
dlog
extract
extract_optional
generate_jobid
get
get_machine
get_optional
get_path
get_required
get_time
inverse
items
last
leave
list_optional
ll_walltime
load
lsf_walltime
max_time
mem_usage
move_from
move_from_optional
move_to
move_to_optional
normalize_time
not_implemented
obj
path_exists
pbs_walltime
process
random_key
restore_default_settings
run_command
sbatch_walltime
select_random
serial
serial_clone
serial_only
set
set_environment
set_id
set_optional
set_path
shallow_copy
split_nodes
tlog
to_dict
to_obj
total_days
total_hours
total_minutes
total_seconds
transfer_from
transfer_to
tree
tuple
values
write_end_splash
write_splash
zero_time

states = finished              int                    none                  int                    running               int                    submitted             int                    waiting               int                 

state_names = 0                     str                    1                     str                    2                     str                    3                     str                    4                     str                 

job_count = 0

static restore_default_settings()

static generate_jobid()

classmethod zero_time()

machine = None

get_machine()

process(machine=None)

process_options(machine=None)

initialize(sim)

renew_app_command(sim)

set_id()

set_processes()

set_environment(limited_env=False, clear_env=False, **env)

divert_out_err()

get_time()

max_time(time)

serial_only()

determine_end_status(status)

write(file=False)

submit()

reenter_queue()

run_command(launcher=None, redirect=False, serial=False)

pbs_walltime()

sbatch_walltime()

ll_walltime()

lsf_walltime()

normalize_time()

total_seconds()

total_minutes()

total_hours()

total_days()

clone()

serial_clone()

split_nodes(n)

class nexus.machines.Machine(name, queue_size=0)

Bases: NexusCore

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
process_job(job)
save([fpath])
sorted_keys()
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
process_job_options
query_queue
random_key
requeue_job
restore_default_settings
select_random
serial
set
set_optional
set_path
shallow_copy
specialized_bundle_commands
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_splash

machines = amber                 Amber                  amos                  Amos                   andes                 Andes                  archer2               Archer2                attaway               Attaway                aurora                Aurora                 baseline              Baseline               besms                 Besms                  bluewaters_xe         BlueWatersXE           bluewaters_xk         BlueWatersXK           cades                 CadesSlurm             cades_moab            CadesMoab              cetus                 Cetus                  cooley                Cooley                 cori                  Cori                   eclipse               Eclipse                eos                   EOS                    flight                Flight                 frontier              Frontier               ghost                 Ghost                  golub                 Golub                  hops                  Hops                   improv                Improv                 inti                  Inti                   jaguar                Jaguar                 kagayaki              Kagayaki               kestrel               Kestrel                komodo                Komodo                 kraken                Kraken                 lassen                Lassen                 leonardo              Leonardo               lonestar              Lonestar               manzano               Manzano                matisse               Matisse                mira                  Mira                   oic5                  OIC5                   perlmutter            Perlmutter             polaris               Polaris                rhea                  Rhea                   ruby                  Ruby                   solo                  Solo                   stampede2             Stampede2              summit                Summit                 supermuc              SuperMUC               supermucng            SuperMUC_NG            theta                 Theta                  titan                 Titan                  tomcat3               Tomcat3                vesta                 Vesta                  ws1                   Workstation            ws10                  Workstation            ws100                 Workstation            ws101                 Workstation            ws102                 Workstation            ws103                 Workstation            ws104                 Workstation            ws105                 Workstation            ws106                 Workstation            ws107                 Workstation            ws108                 Workstation            ws109                 Workstation            ws11                  Workstation            ws110                 Workstation            ws111                 Workstation            ws112                 Workstation            ws113                 Workstation            ws114                 Workstation            ws115                 Workstation            ws116                 Workstation            ws117                 Workstation            ws118                 Workstation            ws119                 Workstation            ws12                  Workstation            ws120                 Workstation            ws121                 Workstation            ws122                 Workstation            ws123                 Workstation            ws124                 Workstation            ws125                 Workstation            ws126                 Workstation            ws127                 Workstation            ws128                 Workstation            ws13                  Workstation            ws14                  Workstation            ws15                  Workstation            ws16                  Workstation            ws17                  Workstation            ws18                  Workstation            ws19                  Workstation            ws2                   Workstation            ws20                  Workstation            ws21                  Workstation            ws22                  Workstation            ws23                  Workstation            ws24                  Workstation            ws25                  Workstation            ws26                  Workstation            ws27                  Workstation            ws28                  Workstation            ws29                  Workstation            ws3                   Workstation            ws30                  Workstation            ws31                  Workstation            ws32                  Workstation            ws33                  Workstation            ws34                  Workstation            ws35                  Workstation            ws36                  Workstation            ws37                  Workstation            ws38                  Workstation            ws39                  Workstation            ws4                   Workstation            ws40                  Workstation            ws41                  Workstation            ws42                  Workstation            ws43                  Workstation            ws44                  Workstation            ws45                  Workstation            ws46                  Workstation            ws47                  Workstation            ws48                  Workstation            ws49                  Workstation            ws5                   Workstation            ws50                  Workstation            ws51                  Workstation            ws52                  Workstation            ws53                  Workstation            ws54                  Workstation            ws55                  Workstation            ws56                  Workstation            ws57                  Workstation            ws58                  Workstation            ws59                  Workstation            ws6                   Workstation            ws60                  Workstation            ws61                  Workstation            ws62                  Workstation            ws63                  Workstation            ws64                  Workstation            ws65                  Workstation            ws66                  Workstation            ws67                  Workstation            ws68                  Workstation            ws69                  Workstation            ws7                   Workstation            ws70                  Workstation            ws71                  Workstation            ws72                  Workstation            ws73                  Workstation            ws74                  Workstation            ws75                  Workstation            ws76                  Workstation            ws77                  Workstation            ws78                  Workstation            ws79                  Workstation            ws8                   Workstation            ws80                  Workstation            ws81                  Workstation            ws82                  Workstation            ws83                  Workstation            ws84                  Workstation            ws85                  Workstation            ws86                  Workstation            ws87                  Workstation            ws88                  Workstation            ws89                  Workstation            ws9                   Workstation            ws90                  Workstation            ws91                  Workstation            ws92                  Workstation            ws93                  Workstation            ws94                  Workstation            ws95                  Workstation            ws96                  Workstation            ws97                  Workstation            ws98                  Workstation            ws99                  Workstation         

modes = batch                 int                    interactive           int                    none                  int                 

mode = 0

batch_capable = False

requires_account = False

executable_subfile = False

redirect_output = False

query_with_username = False

special_bundling = False

prefixed_output = False

outfile_extension = None

errfile_extension = None

allow_warnings = True

queue_configs = None

static get_hostname()

static exists(machine_name)

static is_unique(machine)

static add(machine)

static get(machine_name)

warn(*args, **kwargs)

Warning from inside a Nexus class.

See generic.warn() for description.

validate()

in_batch_mode()

query_queue()

submit_jobs()

process_job(job)

process_job_options(job)

write_job(job, file=False)

submit_job(job)

specialized_bundle_commands(job, launcher, serial)

restore_default_settings()

add_job(job)

requeue_job(job)

allowed_user_info = {'account', 'app_directories', 'app_directory', 'local_directory'}

incorporate_user_info(infoin)

class nexus.machines.Workstation(name='workstation', cores=None, app_launcher='mpirun', process_granularity=1)

Bases: Machine

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
save([fpath])
sorted_keys()
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
job_command
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
process_job
process_job_options
query_queue
random_key
requeue_job
restore_default_settings
select_random
serial
set
set_optional
set_path
shallow_copy
specialized_bundle_commands
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_states
write_splash

mode = 1

batch_capable = False

process_job(job)

process_job_options(job)

write_job_states(title='')

query_queue()

submit_jobs()

job_command(job, pad=None)

write_job(job, file=False)

submit_job(job)

class nexus.machines.InteractiveCluster(*args, **kwargs)

Bases: Workstation

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
save([fpath])
sorted_keys()
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
init_from_args
init_from_supercomputer
inverse
is_unique
items
job_command
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
process_job
process_job_options
query_queue
random_key
requeue_job
restore_default_settings
select_random
serial
set
set_optional
set_path
shallow_copy
specialized_bundle_commands
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_states
write_splash

init_from_args(name='icluster', nodes=None, procs_per_node=None, cores_per_proc=None, process_granularity=None, ram_per_node=None, app_launcher=None)

init_from_supercomputer(super, cores)

process_job(job)

class nexus.machines.Supercomputer(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Machine

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

mode = 2

name = 'supercomputer'

batch_capable = False

aprun_options = {'d', 'n'}

required_inputs = ['nodes', 'procs_per_node', 'cores_per_proc', 'ram_per_node', 'queue_size', 'app_launcher', 'sub_launcher', 'queue_querier', 'job_remover']

interactive_representation(cores)

requeue_job(job)

process_job(job)

process_job_options(job)

pre_process_job(job)

post_process_job(job)

query_queue(out=None)

submit_jobs()

submit_job(job)

sub_command(job)

remove_job(job)

setup_environment(job)

write_job(job, file=False)

write_job_header(job)

static walltime_to_seconds(walltime_str)

Convert walltime string to total seconds Handles formats: ‘dd:hh:mm:ss’, ‘hh:mm:ss’, ‘mm:ss’, ‘seconds’

static seconds_to_walltime(seconds)

Convert total seconds to walltime string Handles formats: ‘dd:hh:mm:ss’, ‘hh:mm:ss’, ‘mm:ss’, ‘seconds’

validate_queue_config(job)

Validate job against queue configuration constraints

Returns:

bool

True if valid, raises an error with detailed message if invalid

Examples

Queue config format

>>> queue_configs = {
...     'default': 'queue_name',
...     'queue_name': {
...         'min_nodes'     : minimum number of nodes,
...         'max_nodes'     : maximum number of nodes,
...         'max_walltime'      : maximum walltime in hours,
...         'cores_per_node': cores per node,
...         'ram_per_node'  : RAM per node in GB,
...         'constraints'   : {
...             'knl': {
...                 'max_nodes': knl specific max nodes,
...                 'max_time': knl specific max time,
...                 ...
...             },
...             'haswell': {...},
...             'gpu': {...},
...             'cpu': {...}
...         }
...     }
... }

read_process_id(output)

class nexus.machines.Kraken(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'kraken'

requires_account = True

write_job_header(job)

class nexus.machines.Jaguar(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'jaguar'

requires_account = True

write_job_header(job)

class nexus.machines.Golub(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'golub'

write_job_header(job)

class nexus.machines.OIC5(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'oic5'

batch_capable = True

write_job_header(job)

read_process_id(output)

class nexus.machines.NerscMachine(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

batch_capable = True

write_job_header(job)

class nexus.machines.Cori(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: NerscMachine

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'cori'

pre_process_job(job)

write_job_header(job)

class nexus.machines.Perlmutter(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: NerscMachine

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'perlmutter'

pre_process_job(job)

write_job_header(job)

class nexus.machines.BlueWatersXK(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'bluewaters_xk'

requires_account = False

batch_capable = True

write_job_header(job)

class nexus.machines.BlueWatersXE(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'bluewaters_xe'

requires_account = False

batch_capable = True

write_job_header(job)

class nexus.machines.Titan(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'titan'

requires_account = True

batch_capable = True

write_job_header(job)

class nexus.machines.EOS(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'eos'

requires_account = True

batch_capable = True

post_process_job(job)

write_job_header(job)

class nexus.machines.ALCF_Machine(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

base_partition

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

requires_account = True

batch_capable = True

executable_subfile = True

prefixed_output = True

outfile_extension = '.output'

errfile_extension = '.error'

base_partition = None

post_process_job(job)

write_job_header(job)

class nexus.machines.Vesta(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: ALCF_Machine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'vesta'

base_partition = 32

class nexus.machines.Cetus(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: ALCF_Machine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'cetus'

base_partition = 128

class nexus.machines.Mira(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: ALCF_Machine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'mira'

base_partition = 512

class nexus.machines.Cooley(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'cooley'

requires_account = True

batch_capable = True

executable_subfile = True

prefixed_output = True

outfile_extension = '.output'

errfile_extension = '.error'

post_process_job(job)

write_job_header(job)

class nexus.machines.Theta(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'theta'

requires_account = True

batch_capable = True

executable_subfile = True

prefixed_output = True

outfile_extension = '.output'

errfile_extension = '.error'

post_process_job(job)

write_job_header(job)

class nexus.machines.Lonestar(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'lonestar'

requires_account = False

batch_capable = True

write_job_header(job)

read_process_id(output)

class nexus.machines.ICMP_Machine(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

batch_capable = True

executable_subfile = True

prefixed_output = True

outfile_extension = '.output'

errfile_extension = '.error'

write_job_header(job)

class nexus.machines.Komodo(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: ICMP_Machine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'komodo'

class nexus.machines.Matisse(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: ICMP_Machine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'matisse'

class nexus.machines.Amos(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'amos'

batch_capable = True

executable_subfile = True

prefixed_output = True

outfile_extension = '.output'

errfile_extension = '.error'

write_job_header(job)

class nexus.machines.SnlMachine(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

requires_account = True

batch_capable = True

gpu_machine = False

reservation_required = False

prefixed_output = True

outfile_extension = '.output'

errfile_extension = '.error'

write_job_header(job)

class nexus.machines.Eclipse(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: SnlMachine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'eclipse'

class nexus.machines.Attaway(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: SnlMachine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'attaway'

class nexus.machines.Manzano(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: SnlMachine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'manzano'

class nexus.machines.Ghost(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: SnlMachine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'ghost'

class nexus.machines.Amber(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: SnlMachine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'amber'

class nexus.machines.Solo(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: SnlMachine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'solo'

class nexus.machines.Flight(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: SnlMachine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'flight'

reservation_required = True

class nexus.machines.Hops(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: SnlMachine

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'hops'

gpu_machine = True

gpus_per_node = 4

class nexus.machines.SuperMUC(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'supermuc'

requires_account = False

batch_capable = True

query_with_username = False

write_job_header(job)

class nexus.machines.SuperMUC_NG(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'supermucng'

requires_account = True

batch_capable = True

query_with_username = True

write_job_header(job)

class nexus.machines.Stampede2(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'stampede2'

requires_account = True

batch_capable = True

prefixed_output = True

outfile_extension = '.output'

errfile_extension = '.error'

write_job_header(job)

class nexus.machines.CadesMoab(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'cades_moab'

requires_account = True

batch_capable = True

post_process_job(job)

write_job_header(job)

class nexus.machines.CadesSlurm(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'cades'

requires_account = True

batch_capable = True

write_job_header(job)

class nexus.machines.Inti(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'inti'

requires_account = False

batch_capable = True

write_job_header(job)

class nexus.machines.Baseline(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'baseline'

requires_account = True

batch_capable = True

queue_configs = {'batch': {'max_nodes': 138, 'max_walltime': '24:00:00'}, 'batch_ccsi': {'max_nodes': 20, 'max_walltime': '24:00:00'}, 'batch_cnms': {'max_nodes': 20, 'max_walltime': '24:00:00'}, 'batch_high_memory': {'max_nodes': 70, 'max_walltime': '24:00:00'}, 'batch_low_memory': {'max_nodes': 68, 'max_walltime': '24:00:00'}, 'default': 'batch_cnms', 'gpu_acmhs': {'max_nodes': 1, 'max_walltime': '24:00:00'}}

write_job_header(job)

class nexus.machines.Frontier(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'frontier'

requires_account = True

batch_capable = True

queue_configs = {'batch': {'max_nodes': 9664, 'max_walltime': '12:00:00'}, 'debug': {'max_nodes': 1, 'max_walltime': '01:00:00'}, 'default': 'batch', 'extended': {'max_nodes': 1894, 'max_walltime': '24:00:00'}}

pre_process_job(job)

post_process_job(job)

write_job_header(job)

class nexus.machines.Besms(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'besms'

requires_account = True

batch_capable = True

queue_configs = {'burst': {'max_nodes': 166, 'max_walltime': '48:00:00'}, 'default': 't92', 't92': {'max_nodes': 10, 'max_walltime': '672:00:00'}, 't92-burst': {'max_nodes': 25, 'max_walltime': '672:00:00'}}

write_job_header(job)

class nexus.machines.Summit(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'summit'

requires_account = True

batch_capable = True

post_process_job(job)

write_job_header(job)

read_process_id(output)

class nexus.machines.Rhea(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'rhea'

requires_account = True

batch_capable = True

prefixed_output = True

outfile_extension = '.output'

errfile_extension = '.error'

post_process_job(job)

write_job_header(job)

class nexus.machines.Leonardo(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
post_process_job(job)	Adjust srun options based on job properties (nodes, processes, threads).
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.
write_job_header(job)	Write the SLURM job script header according to:

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_splash

name = 'leonardo'

requires_account = True

batch_capable = True

prefixed_output = True

outfile_extension = '.out'

errfile_extension = '.err'

booster_qos = {'boost_qos_bprod': {'max_hours': 24.0, 'max_nodes': 256, 'min_nodes': 65}, 'boost_qos_dbg': {'max_hours': 0.5, 'max_nodes': 4, 'min_nodes': 1}, 'boost_qos_lprod': {'max_hours': 96.0, 'max_nodes': 8, 'min_nodes': 1}, 'normal': {'max_hours': 24.0, 'max_nodes': 64, 'min_nodes': 1}}

serial_partition = 'lrd_all_serial'

serial_max_cores = 4

serial_max_hours = 4.0

post_process_job(job)

Adjust srun options based on job properties (nodes, processes, threads). This is called after the Job object is created and before writing the script.

write_job_header(job)

Write the SLURM job script header according to:

• Booster partition (boost_usr_prod) and its QoS table

• Serial partition lrd_all_serial for light tests

Any violation of queue rules (nodes/time/cores/QoS) results in a RuntimeError.

class nexus.machines.Andes(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'andes'

requires_account = True

batch_capable = True

prefixed_output = True

outfile_extension = '.output'

errfile_extension = '.error'

post_process_job(job)

write_job_header(job)

class nexus.machines.Archer2(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'archer2'

requires_account = True

batch_capable = True

prefixed_output = True

outfile_extension = '.output'

errfile_extension = '.error'

post_process_job(job)

write_job_header(job)

class nexus.machines.Tomcat3(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'tomcat3'

requires_account = False

batch_capable = True

redirect_output = True

write_job_header(job)

class nexus.machines.Polaris(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'polaris'

requires_account = True

batch_capable = True

special_bundling = True

post_process_job(job)

write_job_header(job)

specialized_bundle_commands(job, launcher, serial)

class nexus.machines.Aurora(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'aurora'

requires_account = True

batch_capable = True

special_bundling = True

pre_process_job(job)

post_process_job(job)

write_job_header(job)

specialized_bundle_commands(job, launcher, serial)

class nexus.machines.Improv(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'improv'

requires_account = True

batch_capable = True

post_process_job(job)

write_job_header(job)

class nexus.machines.Kagayaki(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'kagayaki'

requires_account = False

batch_capable = True

special_bundling = False

process_job_options(job)

write_job_header(job)

class nexus.machines.Kestrel(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'kestrel'

requires_account = True

batch_capable = True

write_job_header(job)

class nexus.machines.Lassen(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'lassen'

requires_account = True

batch_capable = True

post_process_job(job)

write_job_header(job)

read_process_id(output)

class nexus.machines.Ruby(nodes=None, procs_per_node=None, cores_per_proc=None, ram_per_node=None, queue_size=0, app_launcher=None, sub_launcher=None, queue_querier=None, job_remover=None, name=None)

Bases: Supercomputer

Attributes:

errfile_extension

outfile_extension

queue_configs

working_directory

Methods

append(value)
class_error(message[, header, exit, trace, ...])	Report an error relating to a class.
enter(directory[, changedir, msg])	Have Nexus enter a directory and change its current working directory.
error(message[, header, exit, trace])	Report an error inside a class.
first()
interactive_representation(cores)
keys()
list(*keys)
log(*texts, **kwargs)	Write output to log file.
open_log(filepath)
requeue_job(job)
save([fpath])
seconds_to_walltime(seconds)	Convert total seconds to walltime string Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
sorted_keys()
validate_queue_config(job)	Validate job against queue configuration constraints
walltime_to_seconds(walltime_str)	Convert walltime string to total seconds Handles formats: 'dd:hh:mm:ss', 'hh:mm:ss', 'mm:ss', 'seconds'
warn(*args, **kwargs)	Warning from inside a Nexus class.

add
add_job
add_optional
check_required
check_types
check_types_optional
class_get
class_has
class_items
class_keys
class_log
class_set
class_set_optional
class_set_single
class_warn
clear
close_log
copy
copy_from
copy_to
data_repr
delete
delete_optional
delete_required
dict
dlog
exists
extract
extract_optional
get
get_hostname
get_optional
get_path
get_required
in_batch_mode
incorporate_user_info
inverse
is_unique
items
last
leave
list_optional
load
mem_usage
move_from
move_from_optional
move_to
move_to_optional
not_implemented
obj
path_exists
post_process_job
pre_process_job
process_job
process_job_options
query_queue
random_key
read_process_id
remove_job
restore_default_settings
select_random
serial
set
set_optional
set_path
setup_environment
shallow_copy
specialized_bundle_commands
sub_command
submit_job
submit_jobs
tlog
to_dict
to_obj
transfer_from
transfer_to
tree
tuple
validate
values
write
write_end_splash
write_job
write_job_header
write_splash

name = 'ruby'

requires_account = True

batch_capable = True

write_job_header(job)

nexus.machines.get_machine_name()

nexus.machines.get_machine(machine_name)

nexus.machines.job

alias of Job