Bundle Module#

class nexus.bundle.SimulationBundleInput(*vars, **kwargs)[source]#

Bases: NullSimulationInput

Attributes:
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(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

dlog

extract

extract_optional

get

get_optional

get_path

get_required

incorporate_system

inverse

is_valid

items

last

leave

list_optional

load

mem_usage

move_from

move_from_optional

move_to

move_to_optional

not_implemented

obj

path_exists

random_key

read

read_file_text

read_text

return_structure

return_system

select_random

serial

set

set_optional

set_path

shallow_copy

tlog

to_dict

to_obj

transfer_from

transfer_to

tree

tuple

values

write

write_end_splash

write_file_text

write_splash

write_text

class nexus.bundle.SimulationBundleAnalyzer(sim)[source]#

Bases: NullSimulationAnalyzer

Attributes:
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(msg[, indent])

Warning from inside a Nexus class.

add

add_optional

analyze

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

extract

extract_optional

get

get_optional

get_path

get_required

inverse

items

last

leave

list_optional

load

mem_usage

move_from

move_from_optional

move_to

move_to_optional

not_implemented

obj

path_exists

random_key

select_random

serial

set

set_optional

set_path

shallow_copy

tlog

to_dict

to_obj

transfer_from

transfer_to

tree

tuple

values

write

write_end_splash

write_splash

class nexus.bundle.SimulationBundle(*sims, **kwargs)[source]#

Bases: Simulation

Attributes:
working_directory

Methods

acquire_dependents(sim)

append(value)

class_error(message[, header, exit, trace, ...])

Report an error relating to a class.

eliminate()

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])

separate_inputs(kwargs[, overlapping_kw, ...])

sorted_keys()

traverse_full_cascade(operation, *args, **kwargs)

warn(msg[, indent])

Warning from inside a Nexus class.

active

add

add_optional

analyze

analyzer_type

app_command

attempt_files

block_dependents

bundle_dependencies

bundle_jobs

check_allowed

check_dependencies

check_required

check_result

check_sim_status

check_status

check_subcascade

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

clear_all_sims

close_log

code_name

completed

condense_name

copy

copy_file

copy_from

copy_to

create_directories

data_repr

delete

delete_optional

delete_required

depends

dict

dlog

downstream_simids

errfile_text

execute

extract

extract_optional

fake

fill_produces

fill_products

get

get_dependencies

get_optional

get_output

get_output_files

get_path

get_required

get_result

has_generic_input

idstr

incorporate_result

init_job

init_job_extra

input_type

inverse

items

last

leave

list_optional

load

load_analyzer_image

load_image

mem_usage

move_from

move_from_optional

move_to

move_to_optional

not_implemented

obj

outfile_text

path_exists

post_analyze

post_init

post_submit

pre_check_status

pre_create_directories

pre_init

pre_send_files

pre_write_inputs

progress

propagate_identifier

random_key

ready

reconstruct_cascade

reset_indicators

reset_wait_ids

save_analyzer_image

save_attempt

save_image

select_random

send_files

serial

set

set_app_name

set_directories

set_files

set_optional

set_path

shallow_copy

show_input

submit

tlog

to_dict

to_obj

transfer_from

transfer_to

traverse_cascade

tree

tuple

undo_depends

update_process_id

values

write

write_dependents

write_end_splash

write_inputs

write_prep

write_splash

input_type#

alias of SimulationBundleInput

analyzer_type#

alias of SimulationBundleAnalyzer

generic_identifier = 'bundle'#
image_directory = 'bundle'#
is_bundle = True#
bundle_dependencies()[source]#
bundle_jobs(relative=False, serial=False)[source]#
completed()[source]#
check_allowed(indicator)[source]#
progress(dependency_id=None)[source]#
create_directories(*args, **kwargs)[source]#
get_dependencies(*args, **kwargs)[source]#
write_inputs(*args, **kwargs)[source]#
send_files(*args, **kwargs)[source]#
submit(*args, **kwargs)[source]#
check_sim_status()[source]#
get_output(*args, **kwargs)[source]#
analyze(*args, **kwargs)[source]#
get_output_files()[source]#
app_command()[source]#
nexus.bundle.bundle(*sims, **kwargs)[source]#