Skip to main content
Ctrl+K
WOrflow manager for Ocean Models 2025.10.1 documentation - Home

User Guide

  • Installation
  • Start guide
  • Commandline interface
    • woom
    • woom show
      • woom show overview
      • woom show status
      • woom show run_dirs
      • woom show artifacts
    • woom run
    • woom kill
    • woom clean
  • Examples of configuration
    • A single task with command line formatting
    • Running an ensemble
    • Cycling on date intervals
    • Running all stages
    • Use the templating system
    • Working with artifacts
  • Extending woom
  • From python

Reference

  • Library
    • woom
      • woom.WoomError
    • woom.cli
      • woom.cli.add_parser_clean
      • woom.cli.add_parser_kill
      • woom.cli.add_parser_run
      • woom.cli.add_parser_show
      • woom.cli.add_parser_show_artifacts
      • woom.cli.add_parser_show_overview
      • woom.cli.add_parser_show_run_dirs
      • woom.cli.add_parser_show_status
      • woom.cli.get_parser
      • woom.cli.get_workflow
      • woom.cli.get_workflow_cfg
      • woom.cli.main
      • woom.cli.main_clean
      • woom.cli.main_kill
      • woom.cli.main_run
      • woom.cli.main_show_artifacts
      • woom.cli.main_show_overview
      • woom.cli.main_show_run_dirs
      • woom.cli.main_show_status
      • woom.cli.setup_logger
      • woom.cli.setup_workflow
    • woom.conf
      • woom.conf.VALIDATOR_FUNCTIONS
      • woom.conf.get_cfgspecs
      • woom.conf.get_validator
      • woom.conf.inherit_cfg
      • woom.conf.is_datetime
      • woom.conf.is_pages
      • woom.conf.is_path
      • woom.conf.is_timedelta
      • woom.conf.keep_sections
      • woom.conf.load_cfg
      • woom.conf.merge_args_with_config
      • woom.conf.strip_out_sections
      • woom.conf.WoomConfigError
    • woom.env
      • woom.env.EnvConfig
        • woom.env.EnvConfig.append_paths
        • woom.env.EnvConfig.copy
        • woom.env.EnvConfig.has_vars
        • woom.env.EnvConfig.prepend_paths
        • woom.env.EnvConfig.render
        • woom.env.EnvConfig.set_paths
    • woom.ext
      • woom.ext.import_from_path
      • woom.ext.load_extensions
      • woom.ext.load_jinja_filters
      • woom.ext.load_validator_functions
    • woom.hosts
      • woom.hosts.Host
        • woom.hosts.Host.config
        • woom.hosts.Host.module_setup
        • woom.hosts.Host.name
        • woom.hosts.Host.queues
        • woom.hosts.Host.get_env
        • woom.hosts.Host.get_jobmanager
        • woom.hosts.Host.get_params
        • woom.hosts.Host.get_queue
      • woom.hosts.HostManager
        • woom.hosts.HostManager.config
        • woom.hosts.HostManager.get_host
        • woom.hosts.HostManager.infer_host
        • woom.hosts.HostManager.load_config
      • woom.hosts.HostError
    • woom.iters
      • woom.iters.gen_cycles
      • woom.iters.gen_ensemble
      • woom.iters.Cycle
        • woom.iters.Cycle.begin_date
        • woom.iters.Cycle.date
        • woom.iters.Cycle.is_interval
        • woom.iters.Cycle.is_first
        • woom.iters.Cycle.is_last
        • woom.iters.Cycle.end_date
        • woom.iters.Cycle.duration
        • woom.iters.Cycle.label
        • woom.iters.Cycle.token
        • woom.iters.Cycle.next
        • woom.iters.Cycle.prev
        • woom.iters.Cycle.describe
        • woom.iters.Cycle.get_env_vars
        • woom.iters.Cycle.get_params
      • woom.iters.Member
        • woom.iters.Member.env_vars
        • woom.iters.Member.label
        • woom.iters.Member.params
        • woom.iters.Member.props
        • woom.iters.Member.rank
        • woom.iters.Member.id
        • woom.iters.Member.nmembers
        • woom.iters.Member.set_prop
    • woom.job
      • woom.job.BackgroundJobManager
        • woom.job.BackgroundJobManager.commands
        • woom.job.BackgroundJobManager.status_names
        • woom.job.BackgroundJobManager.check_status
        • woom.job.BackgroundJobManager.delete
        • woom.job.BackgroundJobManager.dump
        • woom.job.BackgroundJobManager.from_scheduler
        • woom.job.BackgroundJobManager.get_command_args
        • woom.job.BackgroundJobManager.get_job
        • woom.job.BackgroundJobManager.get_jobs
        • woom.job.BackgroundJobManager.get_overview
        • woom.job.BackgroundJobManager.get_status
        • woom.job.BackgroundJobManager.get_submission_command
        • woom.job.BackgroundJobManager.kill
        • woom.job.BackgroundJobManager.load
        • woom.job.BackgroundJobManager.load_job
        • woom.job.BackgroundJobManager.set_status
        • woom.job.BackgroundJobManager.submit
      • woom.job.Job
        • woom.job.Job.overview_format
        • woom.job.Job.dump
        • woom.job.Job.get_overview
        • woom.job.Job.get_overview_header
        • woom.job.Job.get_status
        • woom.job.Job.is_running
        • woom.job.Job.kill
        • woom.job.Job.load
        • woom.job.Job.query_status
        • woom.job.Job.set_status
        • woom.job.Job.to_dict
        • woom.job.Job.wait
      • woom.job.JobStatus
        • woom.job.JobStatus.jobid
        • woom.job.JobStatus.FAILED
        • woom.job.JobStatus.ERROR
        • woom.job.JobStatus.SUCCESS
        • woom.job.JobStatus.KILLED
        • woom.job.JobStatus.NOTSUBMITTED
        • woom.job.JobStatus.FINISHED
        • woom.job.JobStatus.UNKNOWN
        • woom.job.JobStatus.PENDING
        • woom.job.JobStatus.RUNNING
        • woom.job.JobStatus.INQUEUE
        • woom.job.JobStatus.EXITING
        • woom.job.JobStatus.COMPLETING
        • woom.job.JobStatus.is_running
        • woom.job.JobStatus.is_not_running
        • woom.job.JobStatus.is_unknown
        • woom.job.JobStatus.is_killed
      • woom.job.PbsproJobManager
        • woom.job.PbsproJobManager.commands
        • woom.job.PbsproJobManager.jobid_sep
        • woom.job.PbsproJobManager.status_names
        • woom.job.PbsproJobManager.check_status
        • woom.job.PbsproJobManager.delete
        • woom.job.PbsproJobManager.dump
        • woom.job.PbsproJobManager.from_scheduler
        • woom.job.PbsproJobManager.get_command_args
        • woom.job.PbsproJobManager.get_job
        • woom.job.PbsproJobManager.get_jobs
        • woom.job.PbsproJobManager.get_overview
        • woom.job.PbsproJobManager.get_status
        • woom.job.PbsproJobManager.get_submission_command
        • woom.job.PbsproJobManager.kill
        • woom.job.PbsproJobManager.load
        • woom.job.PbsproJobManager.load_job
        • woom.job.PbsproJobManager.set_status
        • woom.job.PbsproJobManager.submit
      • woom.job.ScheduledJob
        • woom.job.ScheduledJob.overview_format
        • woom.job.ScheduledJob.dump
        • woom.job.ScheduledJob.get_overview
        • woom.job.ScheduledJob.get_overview_header
        • woom.job.ScheduledJob.get_status
        • woom.job.ScheduledJob.is_running
        • woom.job.ScheduledJob.kill
        • woom.job.ScheduledJob.load
        • woom.job.ScheduledJob.query_status
        • woom.job.ScheduledJob.set_status
        • woom.job.ScheduledJob.to_dict
        • woom.job.ScheduledJob.wait
      • woom.job.SlurmJobManager
        • woom.job.SlurmJobManager.commands
        • woom.job.SlurmJobManager.jobid_sep
        • woom.job.SlurmJobManager.status_names
        • woom.job.SlurmJobManager.check_status
        • woom.job.SlurmJobManager.delete
        • woom.job.SlurmJobManager.dump
        • woom.job.SlurmJobManager.from_scheduler
        • woom.job.SlurmJobManager.get_command_args
        • woom.job.SlurmJobManager.get_job
        • woom.job.SlurmJobManager.get_jobs
        • woom.job.SlurmJobManager.get_overview
        • woom.job.SlurmJobManager.get_status
        • woom.job.SlurmJobManager.get_submission_command
        • woom.job.SlurmJobManager.kill
        • woom.job.SlurmJobManager.load
        • woom.job.SlurmJobManager.load_job
        • woom.job.SlurmJobManager.set_status
        • woom.job.SlurmJobManager.submit
      • woom.job.WoomJobError
    • woom.log
      • woom.log.add_log_level_parser_arguments
      • woom.log.add_logging_parser_arguments
      • woom.log.main_setup_logging
      • woom.log.setup_logging
    • woom.render
      • woom.render.JINJA_ENV
      • woom.render.JINJA_FILTERS
      • woom.render.filter_as_env_str
      • woom.render.filter_replicate_option
      • woom.render.filter_strftime
      • woom.render.render
      • woom.render.setup_template_loader
      • woom.render.WoomLoader
        • woom.render.WoomLoader.has_source_access
        • woom.render.WoomLoader.get_source
        • woom.render.WoomLoader.list_templates
        • woom.render.WoomLoader.load
    • woom.tasks
      • woom.tasks.Task
        • woom.tasks.Task.artifacts
        • woom.tasks.Task.config
        • woom.tasks.Task.env
        • woom.tasks.Task.host
        • woom.tasks.Task.name
        • woom.tasks.Task.run_dir
        • woom.tasks.Task.export
        • woom.tasks.Task.export_artifacts_checking
        • woom.tasks.Task.export_commandline
        • woom.tasks.Task.export_env
        • woom.tasks.Task.export_run_dir
        • woom.tasks.Task.export_scheduler_options
        • woom.tasks.Task.get_run_dir
        • woom.tasks.Task.render_artifacts
        • woom.tasks.Task.render_content
      • woom.tasks.TaskManager
        • woom.tasks.TaskManager.host
        • woom.tasks.TaskManager.get_task
        • woom.tasks.TaskManager.load_config
      • woom.tasks.TaskTree
        • woom.tasks.TaskTree.to_dict
      • woom.tasks.TaskError
    • woom.util
      • woom.util.COLORS
      • woom.util.check_dir
      • woom.util.colorize
      • woom.util.pages2ints
      • woom.util.params2env_vars
      • woom.util.WoomDate
        • woom.util.WoomDate.asm8
        • woom.util.WoomDate.day
        • woom.util.WoomDate.day_of_week
        • woom.util.WoomDate.day_of_year
        • woom.util.WoomDate.dayofweek
        • woom.util.WoomDate.dayofyear
        • woom.util.WoomDate.days_in_month
        • woom.util.WoomDate.daysinmonth
        • woom.util.WoomDate.fold
        • woom.util.WoomDate.hour
        • woom.util.WoomDate.is_leap_year
        • woom.util.WoomDate.is_month_end
        • woom.util.WoomDate.is_month_start
        • woom.util.WoomDate.is_quarter_end
        • woom.util.WoomDate.is_quarter_start
        • woom.util.WoomDate.is_year_end
        • woom.util.WoomDate.is_year_start
        • woom.util.WoomDate.max
        • woom.util.WoomDate.microsecond
        • woom.util.WoomDate.min
        • woom.util.WoomDate.minute
        • woom.util.WoomDate.month
        • woom.util.WoomDate.nanosecond
        • woom.util.WoomDate.quarter
        • woom.util.WoomDate.resolution
        • woom.util.WoomDate.second
        • woom.util.WoomDate.tz
        • woom.util.WoomDate.tzinfo
        • woom.util.WoomDate.unit
        • woom.util.WoomDate.value
        • woom.util.WoomDate.week
        • woom.util.WoomDate.weekofyear
        • woom.util.WoomDate.year
        • woom.util.WoomDate.add
        • woom.util.WoomDate.as_unit
        • woom.util.WoomDate.astimezone
        • woom.util.WoomDate.ceil
        • woom.util.WoomDate.combine
        • woom.util.WoomDate.ctime
        • woom.util.WoomDate.date
        • woom.util.WoomDate.day_name
        • woom.util.WoomDate.dst
        • woom.util.WoomDate.floor
        • woom.util.WoomDate.fromisocalendar
        • woom.util.WoomDate.fromisoformat
        • woom.util.WoomDate.fromordinal
        • woom.util.WoomDate.fromtimestamp
        • woom.util.WoomDate.isocalendar
        • woom.util.WoomDate.isoformat
        • woom.util.WoomDate.isoweekday
        • woom.util.WoomDate.month_name
        • woom.util.WoomDate.normalize
        • woom.util.WoomDate.now
        • woom.util.WoomDate.re_match_since
        • woom.util.WoomDate.replace
        • woom.util.WoomDate.round
        • woom.util.WoomDate.strftime
        • woom.util.WoomDate.strptime
        • woom.util.WoomDate.time
        • woom.util.WoomDate.timestamp
        • woom.util.WoomDate.timetuple
        • woom.util.WoomDate.timetz
        • woom.util.WoomDate.to_datetime64
        • woom.util.WoomDate.to_julian_date
        • woom.util.WoomDate.to_numpy
        • woom.util.WoomDate.to_period
        • woom.util.WoomDate.to_pydatetime
        • woom.util.WoomDate.today
        • woom.util.WoomDate.toordinal
        • woom.util.WoomDate.tz_convert
        • woom.util.WoomDate.tz_localize
        • woom.util.WoomDate.tzname
        • woom.util.WoomDate.utcfromtimestamp
        • woom.util.WoomDate.utcnow
        • woom.util.WoomDate.utcoffset
        • woom.util.WoomDate.utctimetuple
        • woom.util.WoomDate.weekday
      • woom.util.WoomJSONEncoder
        • woom.util.WoomJSONEncoder.item_separator
        • woom.util.WoomJSONEncoder.key_separator
        • woom.util.WoomJSONEncoder.default
        • woom.util.WoomJSONEncoder.encode
        • woom.util.WoomJSONEncoder.iterencode
    • woom.workflow
      • woom.workflow.Workflow
        • woom.workflow.Workflow.config
        • woom.workflow.Workflow.cycles
        • woom.workflow.Workflow.host
        • woom.workflow.Workflow.jobmanager
        • woom.workflow.Workflow.members
        • woom.workflow.Workflow.nmembers
        • woom.workflow.Workflow.output_directories
        • woom.workflow.Workflow.submission_dirs
        • woom.workflow.Workflow.task_tree
        • woom.workflow.Workflow.taskmanager
        • woom.workflow.Workflow.workflow_dir
        • woom.workflow.Workflow.clean
        • woom.workflow.Workflow.clean_task
        • woom.workflow.Workflow.get_app_path
        • woom.workflow.Workflow.get_artifact
        • woom.workflow.Workflow.get_artifacts
        • woom.workflow.Workflow.get_run_dir
        • woom.workflow.Workflow.get_run_dirs
        • woom.workflow.Workflow.get_status
        • woom.workflow.Workflow.get_submission_dir
        • woom.workflow.Workflow.get_task
        • woom.workflow.Workflow.get_task_artifacts
        • woom.workflow.Workflow.get_task_inputs
        • woom.workflow.Workflow.get_task_members
        • woom.workflow.Workflow.get_task_path
        • woom.workflow.Workflow.get_task_status
        • woom.workflow.Workflow.kill
        • woom.workflow.Workflow.run
        • woom.workflow.Workflow.show_artifacts
        • woom.workflow.Workflow.show_overview
        • woom.workflow.Workflow.show_run_dirs
        • woom.workflow.Workflow.show_status
        • woom.workflow.Workflow.submit_task
        • woom.workflow.Workflow.submit_task_fake
      • woom.workflow.WorkFlowError
  • Jinja templates
  • Input mappings
    • Input dictionary
    • Input environment variables
  • Configuration specifications
    • Hosts configuration specifications
    • Tasks configuration specifications
    • Workflow configuration specifications
  • What’s new
  • Contributing guide
  • Github repository
  • Repository
  • Open issue

Python Module Index

c | e | h | i | j | l | r | t | u | w
 
c
woom.cli
woom.conf
 
e
woom.env
woom.ext
 
h
woom.hosts
 
i
woom.iters
 
j
woom.job
 
l
woom.log
 
r
woom.render
 
t
woom.tasks
 
u
woom.util
 
w
woom
woom.workflow

By The Shom team

© Copyright 2025, The Shom team.