Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Snakemake workflow profile as override of local profile #268

Closed
timtroendle opened this issue Jun 23, 2023 · 2 comments · Fixed by #361
Closed

Add Snakemake workflow profile as override of local profile #268

timtroendle opened this issue Jun 23, 2023 · 2 comments · Fixed by #361
Labels
enhancement New feature or request good first issue Good for newcomers workflow Related to the design and execution of the workflow.

Comments

@timtroendle
Copy link
Member

What can be improved?

Snakemake 7.29.0 added the option to have a workflow profile that overrides local profiles. By default, this is profiles/default. We should use this mechanism to allow for local profiles.

As the workflow profile default works for us out of the box, we only need to update to 7.29.0. We can remove the env variable in the default environment.

Version

1.2.0.dev

@timtroendle timtroendle added enhancement New feature or request workflow Related to the design and execution of the workflow. labels Jun 23, 2023
@timtroendle timtroendle added the good first issue Good for newcomers label Feb 23, 2024
@timtroendle
Copy link
Member Author

We should remove the cores parameter from the new workflow-profile, as this clearly is a per-machine, not a per-workflow restriction.

@timtroendle
Copy link
Member Author

timtroendle commented Apr 15, 2024

I tried this just now and there are caveats:

  • Not providing cores may not be a good idea, as Snakemake has no default value and will fail when no user config is provided.
  • The user/local profile is not activated automatically (in contrast to the default workflow profile) and its use is therefore not very user-friendly.

timtroendle added a commit to timtroendle/euro-calliope that referenced this issue Apr 15, 2024
Default profile (in ``profiles/default`) is now the default workflow profile. Snakemake activates it automatically using the name. This allows the user to inject other profile parameters using the `--profile` cli option. This also allows us to provide the conda configuration as an addition to, rather than a replacement of, the default profile.

Fixes calliope-project#268
timtroendle added a commit to timtroendle/euro-calliope that referenced this issue Apr 15, 2024
Default profile (in `profiles/default`) is now the default workflow profile. Snakemake activates it automatically using the name. This allows the user to inject other profile parameters using the `--profile` cli option. This also allows us to provide the conda configuration as an addition to, rather than a replacement of, the default profile.

Fixes calliope-project#268
timtroendle added a commit to timtroendle/euro-calliope that referenced this issue Apr 15, 2024
Default profile (in `profiles/default`) is now the default workflow profile. Snakemake activates it automatically using the name. This allows the user to inject other profile parameters using the `--profile` cli option. This also allows us to provide the conda configuration as an addition to, rather than a replacement of, the default profile.

Fixes calliope-project#268
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers workflow Related to the design and execution of the workflow.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant