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 docker_m1 profile #1942

Merged
merged 5 commits into from
Nov 18, 2022
Merged

Add docker_m1 profile #1942

merged 5 commits into from
Nov 18, 2022

Conversation

ggabernet
Copy link
Member

  • Add docker_m1 profile to pipeline as suggested by @snafees to be able to run pipelines with the docker profile on the Apple M1 chips

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

@codecov
Copy link

codecov bot commented Oct 12, 2022

Codecov Report

Merging #1942 (addf973) into dev (bacb003) will decrease coverage by 0.05%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev    #1942      +/-   ##
==========================================
- Coverage   67.41%   67.36%   -0.06%     
==========================================
  Files          42       42              
  Lines        5463     5463              
==========================================
- Hits         3683     3680       -3     
- Misses       1780     1783       +3     
Impacted Files Coverage Δ
nf_core/modules/test_yml_builder.py 48.18% <0.00%> (-1.37%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@apeltzer
Copy link
Member

@nf-core-bot fix linting

@awgymer
Copy link
Contributor

awgymer commented Oct 12, 2022

I think this needs to come with some kind of documented warning, either at runtime, in the docs, or (preferably imo) both. Whilst the platform option does allow you to get a lot of the functionality and compatibility it can also lead to incredibly slow processes where the emulation doesn't cut it.

It's also possible that you lose a lot of performance running under emulation when native arm containers might actually be available.

EDIT: In fact I don't think the platform variable is necessary to pull amd64 containers when they are the only ones which exist. So setting it only ensures you will never get a (potentially more performant) apple-silicon native container

Copy link
Member

@mirpedrol mirpedrol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code looks good to me!

Maybe to address @awgymer's comment we could add a warning in the documentation, so users only use this profile in case of problems with the regular docker one.
I also have an M1 chip and this was a solution I found, but I don't have enough knowledge to know if this can become a problem for someone.

Copy link
Contributor

@mashehu mashehu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we are more future-proof if we call it docker_arm, since there are already M2 out and in theory other ARM chips would work with this as well (when someone wants to run nextflow on their phones for example 😜).

CHANGELOG.md Outdated Show resolved Hide resolved
nf_core/pipeline-template/nextflow.config Outdated Show resolved Hide resolved
mirpedrol and others added 2 commits November 18, 2022 16:14
Co-authored-by: Matthias Hörtenhuber <mashehu@users.noreply.github.com>
@mirpedrol mirpedrol merged commit eb19d3f into nf-core:dev Nov 18, 2022
@maxulysse
Copy link
Member

a bit late to the party, but why not using the current docker profile and adding an arm profile with just the docker option so we can do
-profile docker,arm?

@mirpedrol mirpedrol mentioned this pull request Nov 21, 2022
4 tasks
@mirpedrol
Copy link
Member

why not using the current docker profile and adding an arm profile with just the docker option so we can do
-profile docker,arm?

Good idea :) I made the PR here #2034

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants