Source code for aiida.orm.implementation.computers
# -*- coding: utf-8 -*-
###########################################################################
# Copyright (c), The AiiDA team. All rights reserved. #
# This file is part of the AiiDA code. #
# #
# The code is hosted on GitHub at https://github.com/aiidateam/aiida-core #
# For further information on the license, see the LICENSE.txt file #
# For further information please visit http://www.aiida.net #
###########################################################################
"""Backend specific computer objects and methods"""
import abc
import logging
from typing import Any, Dict
from .entities import BackendCollection, BackendEntity
__all__ = ('BackendComputer', 'BackendComputerCollection')
[docs]
class BackendComputer(BackendEntity):
"""Backend implementation for the `Computer` ORM class.
A computer is a resource that can be used to run calculations:
It has an associated transport_type, which points to a plugin for connecting to the resource and passing data,
and a scheduler_type, which points to a plugin for scheduling calculations.
"""
# pylint: disable=too-many-public-methods
_logger = logging.getLogger(__name__)
@property
@abc.abstractmethod
def uuid(self) -> str:
"""Return the UUID of the computer."""
@property
@abc.abstractmethod
def label(self) -> str:
"""Return the (unique) label of the computer."""
[docs]
@abc.abstractmethod
def set_label(self, val: str):
"""Set the (unique) label of the computer."""
@property
@abc.abstractmethod
def description(self) -> str:
"""Return the description of the computer."""
[docs]
@abc.abstractmethod
def set_description(self, val: str):
"""Set the description of the computer."""
@property
@abc.abstractmethod
def hostname(self) -> str:
"""Return the hostname of the computer (used to associate the connected device)."""
[docs]
@abc.abstractmethod
def set_hostname(self, val: str) -> None:
"""
Set the hostname of this computer
:param val: The new hostname
"""
[docs]
@abc.abstractmethod
def get_scheduler_type(self) -> str:
"""Return the scheduler plugin type."""
[docs]
@abc.abstractmethod
def set_scheduler_type(self, scheduler_type: str) -> None:
"""Set the scheduler plugin type."""
[docs]
@abc.abstractmethod
def get_transport_type(self) -> str:
"""Return the transport plugin type."""
[docs]
@abc.abstractmethod
def set_transport_type(self, transport_type: str) -> None:
"""Set the transport plugin type."""
[docs]
@abc.abstractmethod
def copy(self) -> 'BackendComputer':
"""Create an un-stored clone of an already stored `Computer`.
:raises: ``InvalidOperation`` if the computer is not stored.
"""
[docs]
class BackendComputerCollection(BackendCollection[BackendComputer]):
"""The collection of Computer entries."""
ENTITY_CLASS = BackendComputer
[docs]
@abc.abstractmethod
def delete(self, pk: int) -> None:
"""
Delete an entry with the given pk
:param pk: the pk of the entry to delete
"""
