search

AgnostiqHQ / covalent-slurm-plugin

Executor plugin interfacing Covalent with Slurm
https://covalent.xyz
Apache License 2.0
27 stars 6 forks source link

Clarify `ssh_key_file` docstring and modify README for `ct.executor.SlurmExecutor` example #76

Closed Andrew-S-Rosen closed 10 months ago

Andrew-S-Rosen commented 12 months ago

This PR seeks to do two things:

  1. Clarify the ssh_key_file (and cert_file) kwargs. Currently, I'm willing to bet many users are going to do ssh_key_file=~/.ssh/id_rsa", but the plugin doesn't call .expanduser() on this, and the GUI will show it as "not found" even if it exists.

  2. Since the ct.executor.SlurmExecutor object requires username, address, and ssh_key_file, I figured it'd be good to add it to the README in a more direct way.

codecov[bot] commented 12 months ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (be1c278) 93.11% compared to head (111af4a) 93.11%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #76 +/- ## ======================================== Coverage 93.11% 93.11% ======================================== Files 2 2 Lines 276 276 ======================================== Hits 257 257 Misses 19 19 ``` | [Files Changed](https://app.codecov.io/gh/AgnostiqHQ/covalent-slurm-plugin/pull/76?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AgnostiqHQ) | Coverage Δ | | |---|---|---| | [covalent\_slurm\_plugin/slurm.py](https://app.codecov.io/gh/AgnostiqHQ/covalent-slurm-plugin/pull/76?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AgnostiqHQ#diff-Y292YWxlbnRfc2x1cm1fcGx1Z2luL3NsdXJtLnB5) | `93.09% <ø> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.