diff --git a/aiida_firecrest/scheduler.py b/aiida_firecrest/scheduler.py index edc5baa..1e60be4 100644 --- a/aiida_firecrest/scheduler.py +++ b/aiida_firecrest/scheduler.py @@ -22,7 +22,9 @@ class FirecrestScheduler(Scheduler): - """Scheduler interface for FirecREST.""" + """Scheduler interface for FirecREST. + It must be used together with the 'firecrest' transport plugin. + """ transport: FirecrestTransport _job_resource_class = SlurmJobResource @@ -32,14 +34,6 @@ class FirecrestScheduler(Scheduler): _logger = Scheduler._logger.getChild("firecrest") _DEFAULT_PAGE_SIZE = 25 - @classmethod - def get_description(cls) -> str: - """Used by verdi to describe the plugin.""" - return ( - "A plugin to connect to a FirecREST server.\n" - "It must be used together with the 'firecrest' transport plugin.\n" - ) - def _get_submit_script_header(self, job_tmpl: JobTemplate) -> str: """ Return the submit script header, using the parameters from the diff --git a/aiida_firecrest/transport.py b/aiida_firecrest/transport.py index c3e5bec..2705e39 100644 --- a/aiida_firecrest/transport.py +++ b/aiida_firecrest/transport.py @@ -233,7 +233,8 @@ def _dynamic_info_direct_size( class FirecrestTransport(Transport): - """Transport interface for FirecREST.""" + """Transport interface for FirecREST. + It must be used together with the 'firecrest' scheduler plugin.""" # override these options, because they don't really make sense for a REST-API, # so we don't want the user having to provide them @@ -421,17 +422,6 @@ def payoff_override(self, value: bool) -> None: raise ValueError("payoff_override must be a boolean value") self._payoff_override = value - @classmethod - def get_description(cls) -> str: - """Used by verdi to describe the plugin.""" - return ( - "A plugin to connect to a FirecREST server.\n" - "It must be used together with the 'firecrest' scheduler plugin.\n" - "Authentication parameters:\n" - ) + "\n".join( - [f" {k}: {v.get('help', '')}" for k, v in cls.auth_options.items()] - ) - def open(self) -> None: """Open the transport. This is a no-op for the REST-API, as there is no connection to open.