Source code for aiida_lammps.utils

"""General utility functions for aiida-lammps"""

import enum

from aiida import __version__ as aiida_version_
from packaging import version



[docs]
def aiida_version():
    """get the version of aiida in use

    :returns: packaging.version.Version
    """
    return version.parse(aiida_version_)




[docs]
def cmp_version(string):
    """convert a version string to a packaging.version.Version"""
    return version.parse(string)




[docs]
class RestartTypes(enum.Enum):
    """Enumeration of the known relax types"""


[docs]
    FROM_SCRATCH = "from_scratch"


[docs]
    FROM_RESTARTFILE = "from_restartfile"


[docs]
    FROM_REMOTEFOLDER = "from_remotefolder"


[docs]
    FROM_STRUCTURE = "from_structure"