Reference Documentation

Autogenerated from doc strings using sphinx’s autodoc feature.

• Main automation module
  • Automator
    • Automator.add_task()
    • Automator.run()
  • CommandTask
    • CommandTask.clean()
    • CommandTask.complete()
    • CommandTask.job
    • CommandTask.output()
    • CommandTask.requires()
    • CommandTask.run()
  • FileCommandTask
    • FileCommandTask.clean()
    • FileCommandTask.output()
  • Problem
    • Problem.clean()
    • Problem.get_commands()
    • Problem.get_name()
    • Problem.get_outputs()
    • Problem.get_requires()
    • Problem.input_path()
    • Problem.make_output_dir()
    • Problem.output_path()
    • Problem.run()
    • Problem.setup()
    • Problem.simulation_path()
    • Problem.task_cls
  • PySPHProblem
    • PySPHProblem.task_cls
  • PySPHTask
  • RunAll
    • RunAll.requires()
  • Simulation
    • Simulation.command
    • Simulation.data
    • Simulation.get_command_line_args()
    • Simulation.get_labels()
    • Simulation.input_path()
    • Simulation.kwargs_to_command_line()
    • Simulation.render_parameter()
  • SolveProblem
    • SolveProblem.complete()
    • SolveProblem.output()
    • SolveProblem.requires()
    • SolveProblem.run()
  • Task
    • Task.complete()
    • Task.output()
    • Task.requires()
    • Task.run()
  • TaskRunner
    • TaskRunner.add_task()
    • TaskRunner.run()
  • WrapperTask
    • WrapperTask.complete()
  • key_to_option()
  • kwargs_to_command_line()
• Utility functions for automation
  • compare_runs()
  • dprod()
  • filter_by_name()
  • filter_cases()
  • mdict()
  • opts2path()
  • styles()
• Low-level job management module
  • Job
    • Job.clean()
    • Job.get_info()
    • Job.get_stderr()
    • Job.get_stdout()
    • Job.join()
    • Job.pretty_command()
    • Job.run()
    • Job.status()
    • Job.substitute_in_command()
    • Job.to_dict()
  • JobProxy
    • JobProxy.clean()
    • JobProxy.copy_output()
    • JobProxy.free_cores()
    • JobProxy.get_info()
    • JobProxy.get_stderr()
    • JobProxy.get_stdout()
    • JobProxy.run()
    • JobProxy.status()
    • JobProxy.total_cores()
  • LocalWorker
    • LocalWorker.clean()
    • LocalWorker.copy_output()
    • LocalWorker.get_config()
    • LocalWorker.get_info()
    • LocalWorker.get_stderr()
    • LocalWorker.get_stdout()
    • LocalWorker.run()
    • LocalWorker.status()
  • RemoteWorker
    • RemoteWorker.clean()
    • RemoteWorker.copy_output()
    • RemoteWorker.free_cores()
    • RemoteWorker.get_config()
    • RemoteWorker.get_info()
    • RemoteWorker.get_stderr()
    • RemoteWorker.get_stdout()
    • RemoteWorker.run()
    • RemoteWorker.status()
    • RemoteWorker.total_cores()
  • Scheduler
    • Scheduler.add_worker()
    • Scheduler.load()
    • Scheduler.save()
    • Scheduler.submit()
  • Worker
    • Worker.can_run()
    • Worker.clean()
    • Worker.copy_output()
    • Worker.cores_required()
    • Worker.free_cores()
    • Worker.get_info()
    • Worker.get_stderr()
    • Worker.get_stdout()
    • Worker.run()
    • Worker.status()
    • Worker.total_cores()
  • cores_required()
  • free_cores()
  • serve()
  • threads_required()
  • total_cores()
• Cluster management module
  • BootstrapError
  • ClusterManager
    • ClusterManager.BOOTSTRAP
    • ClusterManager.UPDATE
    • ClusterManager.add_worker()
    • ClusterManager.cli()
    • ClusterManager.create_scheduler()
    • ClusterManager.delete()
    • ClusterManager.update()
  • CondaClusterManager
    • CondaClusterManager.BOOTSTRAP
    • CondaClusterManager.CONDA_ROOT
    • CondaClusterManager.UPDATE
  • EDMClusterManager
    • EDMClusterManager.BOOTSTRAP
    • EDMClusterManager.EDM_ROOT
    • EDMClusterManager.ENV_FILE
    • EDMClusterManager.UPDATE