Snakemake scheduler plugin: greedy

https://img.shields.io/badge/repository-github-blue?color=%23022c22 GitHub - Last commit https://img.shields.io/badge/author-Filipe%20G.%20Vieira-purple?color=%23064e3b PyPI - Version PyPI - License Snakemake

Warning

No documentation found in repository https://github.com/snakemake/snakemake-scheduler-plugin-greedy. The plugin should provide a docs/intro.md with some introductory sentences and optionally a docs/further.md file with details beyond the auto-generated usage instructions presented in this catalog.

Installation

Install this plugin by installing it with pip or mamba directly, e.g.:

pip install snakemake-scheduler-plugin-greedy

Or, if you are using pixi, add the plugin to your pixi.toml. Be careful to put it under the right dependency type based on the plugin’s availability, e.g.:

snakemake-scheduler-plugin-greedy = "*"

Usage

In order to use the plugin, run Snakemake (>=9.10) with the corresponding value for the scheduler flag:

snakemake --scheduler greedy ...

with ... being any additional arguments you want to use.

Settings

The scheduler plugin has the following settings (which can be passed via command line, the workflow or environment variables, if provided in the respective columns):

Settings

CLI argument

Description

Default

Choices

Required

Type

--scheduler-greedy-greediness VALUE

Set the greediness of scheduling. This value between 0 and 1 determines how careful jobs are selected for execution. The default value (1.0) provides the best speed and still acceptable scheduling quality.

1.0

--scheduler-greedy-omit-prioritize-by-temp-and-input VALUE

If set, jobs with larger temporary or input files are not prioritized. The rationale of the prioritization is that temp files should be removed as soon as possible, and larger input files may take longer to process, so it is better to start them earlier.

False