Skip to content

Commit

Permalink
removed get description from interface (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
khsrali authored Sep 7, 2024
1 parent 151e5a6 commit f94d7a0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 21 deletions.
12 changes: 3 additions & 9 deletions aiida_firecrest/scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
14 changes: 2 additions & 12 deletions aiida_firecrest/transport.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit f94d7a0

Please sign in to comment.