AgnostiqHQ / covalent-slurm-plugin

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

Docs updates: Clarify remote dependencies (`cloudpickle`, `covalent`), Python version matching, and `parsable` flag #48

Closed Andrew-S-Rosen closed 1 year ago

Andrew-S-Rosen commented 1 year ago

What should we add?

  1. cloudpickle needs to be an installed package in the remote machine's Python environment, but this isn't specified anywhere in the docs.

  2. Covalent is also required on the remote machine, which should be specified in the docs.

  3. The SLURM script will not submit if the Python version on the remote machine does not match that used to submit the calculation to the server, as noted here. This should be mentioned in the installation/usage instructions.

  4. The "options": {"parsable": ""} parameter is needed according to Will. This should be added to the docs. I think the SLURM directive is necessary for the job status to be properly logged.

These changes should be reflect in both the README and the main docs. Or maybe it makes sense to keep the README here minimal and link to the corresponding executor docs to not duplicate work? Up to you obviously.