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

Include docs for running on a cluster #529

Closed
trevorb1 opened this issue Feb 10, 2025 · 1 comment
Closed

Include docs for running on a cluster #529

trevorb1 opened this issue Feb 10, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@trevorb1
Copy link
Collaborator

Type of documentation issue

Missing Information

Issue Description

I propose adding a brief section on how to run pypsa-usa on a cluster. Im not suggesting this be a "How to use an HPC" guide or anything. But just instructions like:

  1. Fill in cluster details at config/config.cluster.yaml
  2. Run run_slurm.sh if using SLURM
  3. Modify resource allocations in rules if required

Moreover, the cluster I use does not allow conda. As someone who does not have much HPC experience, navigating how to run pypsa-usa without conda has been a bit of a nightmare. We may want to add some notes on that; or this may resolve itself if we convert to UV for package management (as outlined here)

Link to existing documentation

na

Suggested Update

na

Additional Info

na

@trevorb1 trevorb1 added the documentation Improvements or additions to documentation label Feb 10, 2025
@trevorb1 trevorb1 changed the title Include a section on running on a cluster Include docs for running on a cluster Feb 10, 2025
@trevorb1
Copy link
Collaborator Author

Oh. I didnt realize this already existed in the docs here. My bad.

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

No branches or pull requests

1 participant