lemmings package

Lemmings init

Subpackages

• lemmings.chain package
  • Submodules
  • lemmings.chain.chain module
    • Lemmings
      • Lemmings.next()
      • Lemmings.run()
  • lemmings.chain.common module
  • lemmings.chain.database module
  • lemmings.chain.farming module
    • continue_farming()
    • run_farming()
  • lemmings.chain.lemmingjob_base module
    • LemmingJobBase
      • LemmingJobBase.abort_on_start()
      • LemmingJobBase.after_end_job()
      • LemmingJobBase.check_on_end()
      • LemmingJobBase.check_on_start()
      • LemmingJobBase.exit()
      • LemmingJobBase.prepare_run()
      • LemmingJobBase.prior_to_job()
      • LemmingJobBase.prior_to_new_iteration()
      • LemmingJobBase.set_progress_name()
      • LemmingJobBase.set_progress_var()
    • read_farming_params()
  • lemmings.chain.machine module
  • lemmings.chain.path_tool module
  • lemmings.chain.user module
• lemmings.sandbox package
  • Submodules
  • lemmings.sandbox.sandbox module
    • SmallDb
      • SmallDb.insert()
    • acct_sandbox()
    • cancel_sandbox()
    • qstat_sandbox()
    • start_sandbox()
    • submit_sandbox()
  • lemmings.sandbox.sandbox_cli module

Submodules

lemmings.cli module

CLI for Lemmings

lemmings.cli_farming module

CLI for Lemmings

lemmings.cli_helper module

lemmings.cli_status module

all code concerning the status of lemmings jobs

lemmings.cli_status.customise_end_message(dataBase, loop_num, end_msg)

Function handling the end message output shown in ‘lemmings status’

Input:

database:

database class object

loop_num:

int, number of the loop calling this functionality

Output:

end_message:

str, ouput to be provided

lemmings.cli_status.get_current_status(dataBase, keys=None, with_progress=False)

Function returning the current status of the simulation.

lemmings.cli_status.parallel_status(with_progress, par_dict)