Releases: AgnostiqHQ/covalent-slurm-plugin
Releases · AgnostiqHQ/covalent-slurm-plugin
v0.18.0
[0.18.0] - 2024-01-26
Added
ssh_key_file
andcert_file
paths will now be expanded and resolved to their absolute paths instead of requiring to be absolute in the first place.- Added
ignore_versions
parameter toSlurmExecutor
to allow for ignoring the versions ofpython
,covalent
andcloudpickle
when submitting jobs on the remote machine. - Added further improved error messages in the slurm script.
- Added docker file and its dependent files so that the plugin can be tested using a docker container running slurm.
- Added README.md for the docker tests with steps to manually test the plugin.
Changed
- Changed the strict version pin of
aiofiles
to be>=
instead of==
.
Removed
- Excluding tests from the built package.
- Removed python version pin for pre-commit hooks.
[0.17.0] - 2024-01-19
Added
- add a new
variables
parameter for environment variables - add a new error-catching python execution script (add new module)
- add checks inside submit script for
covalent
andcloudpickle
versions - clean up job script creation (add new module)
- export
COVALENT_CONFIG_DIR=/tmp
inside sbatch script to enable filelock
Changed
- update plugin defaults to use
BaseModel
instead ofdict
- change to actually get errors from these checks
- use
Path
everywhere instead ofos.path
operations - allow
poll_freq >= 10
seconds, instead of 60 seconds - misc. cleanups and refactoring
- Aesthetics and string formatting
- remove addition of
COVALENT_CONFIG_DIR=/tmp
to sbatch script - Removed the
sshproxy
interface. - Updates init signature kwargs replaced with parent for better documentation.
- Updated license to Apache
Docs
- Add missing
,
to README.
v0.12.1-1
v0.16.0
[0.16.0] - 2023-05-12
Added
- A new config variable,
bashrc_path
, which is the path to the bashrc script to source.
Changed
- Removed automatic sourcing of
$HOME/.bashrc
from the SLURM submit script.
Fixed
- Does not put conda-related lines in SLURM script if
conda_env
is set toFalse
or""
. - Changed default config value of
conda_env
fromNone
to""
. - A proper
ValueError
will now be raised ifssh_key_file
is not supplied.
v0.15.0
[0.15.0] - 2023-05-12
Added
- A new kwarg,
use_srun
, that allows for the user to specify whether to usesrun
when running the pickled Python function. - Added docstring for
sshproxy
v0.14.0
[0.14.0] - 2023-05-12
Added
- A new kwarg
create_unique_workdir
that will create unique subfolders of the type<DISPATCH ID>/node_<NODE ID>
withinremote_workdir
if set toTrue
Fixed
- Fixed a bug where
cleanup = False
would be ignored. - Fixed a bug where if
cache_dir
was not present, Covalent would crash.
v0.13.0
[0.13.0] - 2023-05-11
Changed
- Updated pre-commit hooks
Release v0.12.1
[0.12.1] - 2023-05-05
Fixed
- Moved executor validations out of constructor
Operations
- Fixed license CI workflow
Release v0.12.0
[0.12.0] - 2023-05-05
Added
- Basic support for NERSC's sshproxy tool which uses MFA to generate SSH keys
[0.11.0] - 2023-05-02
Added
- Added instructions to the
README
for the remote machine's dependencies.
Changed
- Automatically apply the
"parsable": ""
option by default if not set by the user.
[0.10.0] - 2023-05-01
Added
- Modified executor to use
srun
in slurm script, instead of injecting python code and calling python directly. - Added new parameters to
SlurmExecutor
to allow finer control of jobs via options forsrun
and in-script commands (see README.md). - Added
srun_append
parameter allowing insertion of intermediate command (see README.md). - Added
prerun_commands
andpostrun_commands
parameters allowing execution of in-script shell commands before and after the workflow submission viasrun
(see README.md).
[0.9.0] - 2023-04-30
Added
- Added a new kwarg,
cert_file
, toSlurmExecutor
that allows for a certificate file to be passed.
Changed
- Changed the
_client_connect
function to output the connection object only since the first positional argument cannot get used.
Operations
- Added Alejandro to paul blart group
v0.8.0
[0.8.0] - 2022-11-19
Changed
- Changed BaseAsyncExecutor to AsyncBaseExecutor
- Updated covalent version to >=0.202.0,<1
Operations
- Added license workflow
Tests
- Enabled Codecov
v0.7.0
[0.7.0] - 2022-08-23
Added
SlurmExecutor
can now be import directly fromcovalent_slurm_plugin
- Added several debug log statements to track progress when debugging
asyncssh
added as a requirement- Added support for performing cleanup on remote machine (default is True) once execution completes
- Added
slurm_path
for users to provide a path for slurm commands if they aren't detected automatically
Changed
- Default values set for some
SlurmExecutor
initialization parameters - Since there were several ssh calls, thus now using
asyncssh
module for a uniform interface to run ssh commands on remote machine - File transfer to and from is now done using
scp
instead ofrsync
Fixed
- Fixed returning only
result
fromrun
method instead of returningstdout
andstderr
as well, which are now printed directly appropriately
Tests
- Updated tests to reflect above changes