Skip to content

Add Host Requirements to Devcontainer Config #3746

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.

Sign up for GitHub

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

Jump to bottom
Merged
JulianFlesch merged 2 commits into from
Sep 8, 2025
Merged

Add Host Requirements to Devcontainer Config #3746

JulianFlesch merged 2 commits into from
Sep 8, 2025

Conversation

@JulianFlesch
Copy link
Contributor

@JulianFlesch JulianFlesch commented Sep 5, 2025

Adds a hostRequirements section to the devcontainer configuration.

        "cpus": 4,
        "memory": "16gb",
        "storage": "32gb"

This leads to using the larger (free-tier) machine type available in Codespaces by default.

Locally, these seem to behave like "soft" requirements. If your machine does not satisfy these, you see an alert window like this:
Screenshot 2025-09-05 at 14 38 04

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

@JulianFlesch JulianFlesch requested a review from a team September 5, 2025 12:43
@JulianFlesch JulianFlesch self-assigned this Sep 5, 2025
@JulianFlesch JulianFlesch changed the title impr: Add hostRequirements to run with 4CPUs and 16GB ram by default … Add Host Requirements to Devcontainer Config Sep 5, 2025
mirpedrol
mirpedrol approved these changes Sep 5, 2025
View reviewed changes
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.

LGTM
What happens if you run something that takes more resources than available locally? In any case I think it's ok, you would have errors anyway if you request more resources outside of a devcontainer

@JulianFlesch
Copy link
Contributor Author

JulianFlesch commented Sep 8, 2025

What happens if you run something that takes more resources than available locally?

It would fail with an error from your system, e.g if too much memory is requested. And Nextflow handles errors where more cpus are requested in a process definition than are available.

@JulianFlesch JulianFlesch merged commit 7ae6720 into nf-core:dev Sep 8, 2025
116 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mirpedrol mirpedrol mirpedrol approved these changes

Assignees

@JulianFlesch JulianFlesch

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@JulianFlesch @mirpedrol @nf-core-bot