diff --git a/docs/_build/doctrees/api/tcutility.data.atom_data_info.doctree b/docs/_build/doctrees/api/tcutility.data.atom_data_info.doctree new file mode 100644 index 00000000..c41d0d96 Binary files /dev/null and b/docs/_build/doctrees/api/tcutility.data.atom_data_info.doctree differ diff --git a/docs/_build/doctrees/api/tcutility.data.doctree b/docs/_build/doctrees/api/tcutility.data.doctree new file mode 100644 index 00000000..ceb131c1 Binary files /dev/null and b/docs/_build/doctrees/api/tcutility.data.doctree differ diff --git a/docs/_build/doctrees/api/tcutility.doctree b/docs/_build/doctrees/api/tcutility.doctree index ecf2121f..58b0369c 100644 Binary files a/docs/_build/doctrees/api/tcutility.doctree and b/docs/_build/doctrees/api/tcutility.doctree differ diff --git a/docs/_build/doctrees/api/tcutility.job.doctree b/docs/_build/doctrees/api/tcutility.job.doctree index e2537876..ff9f4ddc 100644 Binary files a/docs/_build/doctrees/api/tcutility.job.doctree and b/docs/_build/doctrees/api/tcutility.job.doctree differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index a2770b92..31772ad8 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html index 7a6bbbf4..22519501 100644 --- a/docs/_build/html/_modules/index.html +++ b/docs/_build/html/_modules/index.html @@ -254,6 +254,9 @@

All modules for which code is available

  • tcutility.analysis.vdd.manager
  • tcutility.analysis.vibration.ts_vibration
  • tcutility.cache
  • +
  • tcutility.data.atom
  • +
  • tcutility.data.functionals
  • +
  • tcutility.data.molecules
  • tcutility.formula
  • tcutility.geometry
  • tcutility.job.adf
  • diff --git a/docs/_build/html/_modules/tcutility.html b/docs/_build/html/_modules/tcutility.html index 95a9e6eb..13d8f78d 100644 --- a/docs/_build/html/_modules/tcutility.html +++ b/docs/_build/html/_modules/tcutility.html @@ -271,7 +271,7 @@

    Source code for tcutility

     
     
     
    -from tcutility import constants, formula, geometry, log, molecule, results, slurm, data  # noqa: F401, E402
    +from tcutility import constants, formula, geometry, log, molecule, results, slurm, data, analysis, spell_check  # noqa: F401, E402
     
    diff --git a/docs/_build/html/_modules/tcutility/data/atom.html b/docs/_build/html/_modules/tcutility/data/atom.html new file mode 100644 index 00000000..c63f3264 --- /dev/null +++ b/docs/_build/html/_modules/tcutility/data/atom.html @@ -0,0 +1,420 @@ + + + + + + + + + + tcutility.data.atom — TCutility v0.8.5 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + +
    +
    +
    +
    +
    + + + + +
    +
    + + + + + +
    + + + + + + + + + + + +
    + +
    + + +
    +
    + +
    +
    + +
    + +
    + + + + +
    + +
    + + +
    +
    + + + + + +
    + +

    Source code for tcutility.data.atom

    +import pathlib as pl
    +
    +
    +# read data
    +data_dir = pl.Path(__file__).parents[0] / "atom_data_info"
    +
    +with open(data_dir / "name.txt") as data:
    +    lines = data.readlines()
    +_element_order = [line.split(",")[1].strip() for line in lines]
    +
    +with open(data_dir / "symbol.txt") as data:
    +    lines = data.readlines()
    +_symbol_order = [line.split(",")[1].strip() for line in lines]
    +
    +with open(data_dir / "radius.txt") as data:
    +    lines = data.readlines()
    +_radii = {int(line.split(",")[0]): float(line.split(",")[1].strip()) for line in lines}
    +
    +with open(data_dir / "color.txt") as data:
    +    lines = data.readlines()
    +_colors = {int(line.split(",")[0]): [int(x.strip()) for x in line.split(",")[1:]] for line in lines}
    +
    +
    +
    +[docs] +def parse_element(val): + """ + Parse a str or int to an atom number. + + Args: + val: Element name, symbol or atom number. + + Returns: + Atom number corresponding to val. + + Examples: + + .. code-block:: python + + parse_element('Hydrogen') == 1 + parse_element('C') == 6 + parse_element(23) == 23 + """ + # we will assume an integer value is an atom number already + if isinstance(val, int): + return val + # if it is not an int it should be a string + if val.lower() in _element_order: + # first try to get it in the element name list + return _element_order.index(val.lower()) + 1 + if val in _symbol_order: + # alternatively try to get it in the symbol list + return _symbol_order.index(val) + 1 + raise KeyError(f'Element "{val}" not parsable.')
    + + + +
    +[docs] +def radius(element): + ''' + Args: + element: the symbol, name or atom number of the element. See :func:`parse_element`. + Return: + The empirical covalent radius of an element in angstroms, up to element 96. + ''' + num = parse_element(element) + return _radii.get(num)
    + + + +
    +[docs] +def color(element): + ''' + Args: + element: the symbol, name or atom number of the element. See :func:`parse_element`. + + Return: + The standard CPK colors of the elements, up to element 109. + ''' + num = parse_element(element) + return _colors[num]
    + + + +if __name__ == "__main__": + print(color("carbon")) +
    + +
    + + + + + +
    + +
    +
    +
    + +
    + + + +
    + + +
    + + +
    +
    +
    + + + + + + + + \ No newline at end of file diff --git a/docs/_build/html/_modules/tcutility/data/functionals.html b/docs/_build/html/_modules/tcutility/data/functionals.html new file mode 100644 index 00000000..c0d59be9 --- /dev/null +++ b/docs/_build/html/_modules/tcutility/data/functionals.html @@ -0,0 +1,534 @@ + + + + + + + + + + tcutility.data.functionals — TCutility v0.8.5 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + +
    +
    +
    +
    +
    + + + + +
    +
    + + + + + +
    + + + + + + + + + + + +
    + +
    + + +
    +
    + +
    +
    + +
    + +
    + + + + +
    + +
    + + +
    +
    + + + + + +
    + +

    Source code for tcutility.data.functionals

    +import os
    +from tcutility import results, log, spell_check
    +
    +
    +j = os.path.join
    +
    +
    +
    +[docs] +def get(functional_name: str) -> results.Result: + ''' + Return information about a given functional. + + Args: + functional_name: the name of the functional. It should exist in the :func:`get_available_functionals` keys. + + Return: + A |Result| object containing information about the functional if it exists. Else it will return ``None``. + + .. seealso:: + :func:`get_available_functionals` for an overview of the information returned. + ''' + + spell_check.check(functional_name, functionals.keys(), caller_level=3) + return functionals[functional_name]
    + + + +
    +[docs] +def functional_name_from_path_safe_name(path_safe_name: str) -> results.Result: + ''' + Return information about a given functional given its path-safe name. + This can be useful when you want to know the functional from a path name. + + Return: + A |Result| object containing information about the functional if it exists. Else it will return ``None``. + + .. seealso:: + :func:`get_available_functionals` for an overview of the information returned. + ''' + for functional, functional_info in functionals.items(): + if path_safe_name == functional_info.path_safe_name: + return functional
    + + + +
    +[docs] +def get_available_functionals(): + ''' + Function that returns a dictionary of all available XC-functionals. + + Returns: + : A |Result| object containing information about all available XC-functionals. + The functional names are stored as the keys and the functional information is stored as the values. + The values contain the following information: + + - ``name`` **(str)** - the name of the functional. + - ``path_safe_name`` **(str)** - the name of the functional made suitable for file paths. + This name is the same as the normal name, but without parentheses. Asterisks are replaced with lower-case ``s``. + - ``name_no_disp`` **(str)** - the name of functional without the dispersion correction. + - ``category`` **(str)** - the category the functional belongs to. + - ``dispersion`` **(str)** - the dispersion correction part of the functional name. + - ``dispersion_name`` **(str)** - the name of the dispersion correction as it would be written in ADF. + - ``includes_disp`` **(bool)** - whether the functional already includes a dispersion correction. + - ``use_libxc`` **(bool)** - whether the functional is from the LibXC library. + - ``available_in_adf`` **(bool)** - whether the functional is available in ADF. + - ``available_in_band`` **(bool)** - whether the functional is available in BAND. + - ``available_in_orca`` **(bool)** - whether the functional is available in ORCA. + - ``adf_settings`` **(|Result|)** - the settings that are used to select the functional in the ADF input. + ''' + def set_dispersion(func): + disp_map = { + '-D4': 'GRIMME4', + '-D3(BJ)': 'GRIMME3 BJDAMP', + '-D3BJ': 'GRIMME3 BJDAMP', + '-D3': 'GRIMME3', + '-dDsC': 'dDsC', + '-dUFF': 'UFF', + '-MBD': 'MBD', + '-MBD@rsSC': 'MBD', + '-D': 'DEFAULT' + } + + # set some default values for useful parameters + func.name_no_disp = func.name + func.dispersion = None + func.dispersion_name = None + + # go through every dispersion correction and check if we are using it + for disp_suffix, disp_name in disp_map.items(): + if func.name.endswith(disp_suffix): + # dispersion will be the suffix without the - + func.dispersion = disp_suffix[1:] + func.dispersion_name = disp_name + + # check if the functional already includes the dispersion correction + if func.includes_disp: + break + + # else we set the name of the functional without dispersion for later + func.name_no_disp = func.name[:-len(disp_suffix)] + # get the dispersion settings for ADF. Try to get custom values if they were provided. + func.adf_settings.XC.Dispersion = func.disp_params or disp_name + break + + def set_functional(func): + # set the functional settings for ADF + # first go through some special functionals that require special settings + if func.name_no_disp == 'BMK': + func.adf_settings.XC.LibXC = 'HYB_MGGA_X_BMK GGA_C_BMK' + return + + if func.name in ['LCY-BLYP', 'LCY-BP86', 'LCY-PBE']: + func.adf_settings.XC.GGA = func.name.split('-')[1] + func.adf_settings.XC.RANGESEP = '' + func.adf_settings.XC.xcfun = '' + return + + if func.name in ['CAMY-B3LYP']: + func.adf_settings.XC.Hybrid = 'CAMY-B3LYP' + func.adf_settings.XC.RANGESEP = '' + func.adf_settings.XC.xcfun = '' + return + + if func.name == 'GGA:SSB-D': + func.adf_settings.XC.GGA = 'SSB-D' + return + + if func.name == 'MetaGGA:SSB-D': + func.adf_settings.XC.MetaGGA = 'SSB-D' + return + + if func.name_no_disp == 'HartreeFock': + func.adf_settings.XC.HartreeFock = '' + return + + if func.name == 'MP2': + func.adf_settings.XC.MP2 = '' + return + + if func.name in ['SOS-MP2', 'SCS-MP2']: + func.adf_settings.XC.MP2 = '' + func.adf_settings.XC.EmpiricalScaling = func.name[:-4] + return + + # the normal functionals are defined based on their category, or selected from libxc + if func.use_libxc: + func.adf_settings.XC.LibXC = func.name_no_disp + else: + func.adf_settings.XC[func.category] = func.name_no_disp + + # gather all data about available functionals + functionals = results.Result() # store all info in this dict + + with open(j(os.path.split(__file__)[0], 'available_functionals.txt')) as file: + lines = file.readlines() + + for line in lines: + # there can be empty lines + if not line.strip(): + continue + + # functional names are given starting with - + # category names without - + if not line.startswith('- '): + curr_category = line.strip() + continue + + # store data about the func in a dict + func = results.Result() + func.category = curr_category + + # separate the functional name from the line + functional_name = line[2:].split('!')[0].split(',')[0].strip() + func.name = functional_name + func.path_safe_name = functional_name.replace(')', '').replace('(', '').replace('*', 's') + + # check if custom params were given for dispersion + if 'GRIMME' in line: + func.disp_params = line.split('!')[0].split(',')[1].strip().strip("'") + + func.use_libxc = '!libxc' in line + func.includes_disp = '!includesdisp' in line + func.available_in_adf = '!noadf' not in line + func.available_in_band = '!band' in line + func.available_in_orca = '!orca' in line + + set_dispersion(func) + set_functional(func) + + functionals[functional_name] = func + + return functionals
    + + +functionals = get_available_functionals() + + +if __name__ == '__main__': + log.log(get('LYP')) +
    + +
    + + + + + +
    + +
    +
    +
    + +
    + + + +
    + + +
    + + +
    +
    +
    + + + + + + + + \ No newline at end of file diff --git a/docs/_build/html/_modules/tcutility/data/molecules.html b/docs/_build/html/_modules/tcutility/data/molecules.html new file mode 100644 index 00000000..7e57d84d --- /dev/null +++ b/docs/_build/html/_modules/tcutility/data/molecules.html @@ -0,0 +1,365 @@ + + + + + + + + + + tcutility.data.molecules — TCutility v0.8.5 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + +
    +
    +
    +
    +
    + + + + +
    +
    + + + + + +
    + + + + + + + + + + + +
    + +
    + + +
    +
    + +
    +
    + +
    + +
    + + + + +
    + +
    + + +
    +
    + + + + + +
    + +

    Source code for tcutility.data.molecules

    +from tcutility import molecule
    +import os
    +
    +
    +j = os.path.join
    +
    +root_dir = j(os.path.split(__file__)[0], 'molecules')
    +
    +
    +
    +[docs] +def get(name): + p = j(root_dir, f'{name.removesuffix(".xyz")}.xyz') + return molecule.load(p)
    + + + +
    +[docs] +def get_molecules(tags=None): + for f in os.listdir(root_dir): + if not f.endswith('.xyz'): + continue + + mol = get(f) + if tags is None or any(tag in mol.flags.tags for tag in tags): + yield mol
    + + + +if __name__ == '__main__': + for mol in get_molecules(): + print(mol, mol.flags) +
    + +
    + + + + + +
    + +
    +
    +
    + +
    + + + +
    + + +
    + + +
    +
    +
    + + + + + + + + \ No newline at end of file diff --git a/docs/_build/html/_modules/tcutility/job/adf.html b/docs/_build/html/_modules/tcutility/job/adf.html index efd0c270..79326850 100644 --- a/docs/_build/html/_modules/tcutility/job/adf.html +++ b/docs/_build/html/_modules/tcutility/job/adf.html @@ -256,8 +256,7 @@

    Source code for tcutility.job.adf

     from scm import plams
    -from tcutility import log, results, formula
    -from tcutility.data import functionals
    +from tcutility import log, results, formula, spell_check, data
     from tcutility.job.ams import AMSJob
     import os
     
    @@ -271,11 +270,11 @@ 

    Source code for tcutility.job.adf

         def __init__(self, *args, **kwargs):
             super().__init__(*args, **kwargs)
             self._functional = None
    +        self.solvent('vacuum')
             self.basis_set('TZ2P')
             self.quality('Good')
             self.SCF_convergence(1e-8)
             self.single_point()
    -        self.solvent('vacuum')
     
         def __str__(self):
             return f'{self._task}({self._functional}/{self._basis_set}), running in {os.path.join(os.path.abspath(self.rundir), self.name)}'
    @@ -290,8 +289,16 @@ 

    Source code for tcutility.job.adf

                 typ: the type of basis-set to use. Default is TZ2P.
                 core: the size of the frozen core approximation. Default is None.
     
    +        Raises:
    +            ValueError: if the basis-set name or core is incorrect.
    +
             .. note:: If the selected functional is the r2SCAN-3c functional, then the basis-set will be set to mTZ2P.
    +
    +        .. seealso:: 
    +            :mod:`tcutility.data.basis_sets` for an overview of the available basis-sets in ADF.
             '''
    +        spell_check.check(typ, data.basis_sets.available_basis_sets['ADF'], ignore_case=True)
    +        spell_check.check(core, ['None', 'Small', 'Large'], ignore_case=True)
             if self._functional == 'r2SCAN-3c' and typ != 'mTZ2P':
                 log.warn(f'Basis set {typ} is not allowed with r2SCAN-3c, switching to mTZ2P.')
                 typ = 'mTZ2P'
    @@ -323,7 +330,7 @@ 

    Source code for tcutility.job.adf

             3) triplet
             4) ...
         
    -        The multiplicity is equal to 2*S+1 for spin-polarization of S.
    +        The multiplicity is equal to 2*S+1 for spin-polarization S.
             '''
             self.settings.input.adf.SpinPolarization = (val - 1)//2
             if val != 1:
    @@ -347,7 +354,11 @@ 

    Source code for tcutility.job.adf

     
             Args:
                 val: the numerical quality value to set to. This is the same as the ones used in the ADF GUI. Defaults to Good.
    +
    +        Raises:
    +            ValueError: if the quality value is incorrect.
             '''
    +        spell_check.check(val, ['Basic', 'Normal', 'Good', 'VeryGood', 'Excellent'], ignore_case=True)
             self.settings.input.adf.NumericalQuality = val
    @@ -370,10 +381,16 @@

    Source code for tcutility.job.adf

             Set the functional to be used by the calculation. This also sets the dispersion if it is specified in the functional name.
     
             Args:
    -            funtional_name: the name of the functional. The value can be the same as the ones used in the ADF GUI. For a full list of functionals please see :func:`functionals.get_available_functionals`.
    +            funtional_name: the name of the functional. The value can be the same as the ones used in the ADF GUI.
                 dispersion: dispersion setting to use with the functional. This is used when you want to use a functional from LibXC.
     
    +        Raises:
    +            ValueError: if the functional name is not recognized.
    +
             .. note:: Setting the functional to r2SCAN-3c will automatically set the basis-set to mTZ2P.
    +
    +        .. seealso::
    +            :mod:`tcutility.data.functionals` for an overview of the available functionals in ADF.
             '''
             # before adding the new functional we should clear any previous functional settings
             self.settings.input.adf.pop('XC', None)
    @@ -390,11 +407,11 @@ 

    Source code for tcutility.job.adf

                 log.error('There are two functionals called SSB-D, please use "GGA:SSB-D" or "MetaGGA:SSB-D".')
                 return
     
    -        if not functionals.get(functional):
    +        if not data.functionals.get(functional):
                 log.warn(f'XC-functional {functional} not found. Please ask a TheoCheM developer to add it. Adding functional as LibXC.')
                 self.settings.input.adf.XC.LibXC = functional
             else:
    -            func = functionals.get(functional)
    +            func = data.functionals.get(functional)
                 self.settings.input.adf.update(func.adf_settings)
    @@ -406,7 +423,11 @@

    Source code for tcutility.job.adf

     
             Args:
                 level: the level to set. Can be the same as the values in the ADF GUI and documentation. By default it is set to Scalar.
    +
    +        Raises:
    +            ValueError: if the relativistic correction level is not correct.
             '''
    +        spell_check.check(level, ['Scalar', 'None', 'Spin-Orbit'], ignore_case=True)
             self.settings.input.adf.relativity.level = level
    @@ -421,8 +442,15 @@

    Source code for tcutility.job.adf

                 eps: the dielectric constant of your solvent. You can use this in place of the solvent name if you need more control over COSMO.
                 rad: the radius of the solvent molecules. You can use this in place of the solvent name if you need more control over COSMO.
                 use_klamt: whether to use the klamt atomic radii. This is usually used when you have charged species (?).
    +
    +        Raises:
    +            ValueError: if the solvent name is given, but incorrect.
    +
    +        .. seealso::
    +            :mod:`tcutility.data.cosmo` for an overview of the available solvent names and formulas.
             '''
             if name:
    +            spell_check.check(name, data.cosmo.available_solvents, ignore_case=True, insertion_cost=0.3)
                 self._solvent = name
             else:
                 self._solvent = f'COSMO(eps={eps} rad={rad})'
    @@ -614,8 +642,10 @@ 

    Source code for tcutility.job.adf

             job.rundir = 'tmp/SN2/EDA'
             job.molecule('../../../test/fixtures/xyz/pyr.xyz')
             job.sbatch(p='tc', ntasks_per_node=15)
    -        job.functional('OLYP')
    -        job.basis_set('DZP')
    +        job.solvent('')
    +        job.basis_set('tz2p')
    +        job.quality('veryGood')
    +        job.functional('LYP-D3BJ')
     
    diff --git a/docs/_build/html/_modules/tcutility/spell_check.html b/docs/_build/html/_modules/tcutility/spell_check.html index 42af72b1..c788ba6b 100644 --- a/docs/_build/html/_modules/tcutility/spell_check.html +++ b/docs/_build/html/_modules/tcutility/spell_check.html @@ -352,7 +352,7 @@

    Source code for tcutility.spell_check

     
     
    [docs] -def get_closest(a: str, others: List[str], compare_func=wagner_fischer, ignore_case: bool = False, ignore_chars: str = '', maximum_distance: int = None) -> List[str]: +def get_closest(a: str, others: List[str], compare_func=wagner_fischer, ignore_case: bool = False, ignore_chars: str = '', maximum_distance: int = None, **kwargs) -> List[str]: ''' Return strings that are similar to an input string using the Levenshtein distance. @@ -369,6 +369,7 @@

    Source code for tcutility.spell_check

         Returns:
             A collection of strings that have a Levenshtein distance to ``a`` below ``maximum_distance`` 
             or have the lowest distance to ``a`` if all strings have a distance greater than ``maximum_distance``.
    +        If the lowest distance is ``0``, return an empty list instead.
     
         Example:
             .. code-block:: python
    @@ -391,11 +392,11 @@ 

    Source code for tcutility.spell_check

             for char in ignore_chars:
                 other = other.replace(char, '')
     
    -        dists.append(compare_func(a, other))
    +        dists.append(compare_func(a, other, **kwargs))
     
         if maximum_distance is None:
             maximum_distance = -1
    -    lowest_strs = [other for dist, other in zip(dists, others) if dist <= max(maximum_distance, min(dists))]
    +    lowest_strs = [other for dist, other in zip(dists, others) if 0 < dist <= max(maximum_distance, min(dists))]
         return lowest_strs
    @@ -425,6 +426,24 @@

    Source code for tcutility.spell_check

         # write a warning message
         log.warn(f'Could not find "{a}". Did you mean {closest_string}?', caller_level=3)
    + + +
    +[docs] +def check(a: str, others: List[str], caller_level=2, **kwargs): + closest = get_closest(a, others, **kwargs) + if len(closest) == 0: + return + + if len(closest) > 1: + closest_string = " or ".join([", ".join(closest[:-1]), closest[-1]]) + else: + closest_string = closest[0] + + # write a warning message + msg = f"({log.caller_name(caller_level)}): " + f'Could not find "{a}". Did you mean {closest_string}?' + raise ValueError(msg)
    +
    diff --git a/docs/_build/html/_sources/api/tcutility.data.atom_data_info.rst.txt b/docs/_build/html/_sources/api/tcutility.data.atom_data_info.rst.txt new file mode 100644 index 00000000..7b4c05e9 --- /dev/null +++ b/docs/_build/html/_sources/api/tcutility.data.atom_data_info.rst.txt @@ -0,0 +1,10 @@ +tcutility.data.atom\_data\_info package +======================================= + +Module contents +--------------- + +.. automodule:: tcutility.data.atom_data_info + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_build/html/_sources/api/tcutility.data.rst.txt b/docs/_build/html/_sources/api/tcutility.data.rst.txt new file mode 100644 index 00000000..44b0121c --- /dev/null +++ b/docs/_build/html/_sources/api/tcutility.data.rst.txt @@ -0,0 +1,61 @@ +tcutility.data package +====================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + tcutility.data.atom_data_info + +Submodules +---------- + +tcutility.data.atom module +-------------------------- + +.. automodule:: tcutility.data.atom + :members: + :undoc-members: + :show-inheritance: + +tcutility.data.basis\_sets module +--------------------------------- + +.. automodule:: tcutility.data.basis_sets + :members: + :undoc-members: + :show-inheritance: + +tcutility.data.cosmo module +--------------------------- + +.. automodule:: tcutility.data.cosmo + :members: + :undoc-members: + :show-inheritance: + +tcutility.data.functionals module +--------------------------------- + +.. automodule:: tcutility.data.functionals + :members: + :undoc-members: + :show-inheritance: + +tcutility.data.molecules module +------------------------------- + +.. automodule:: tcutility.data.molecules + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tcutility.data + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_build/html/_sources/api/tcutility.rst.txt b/docs/_build/html/_sources/api/tcutility.rst.txt index 4b98ca3c..3654fd72 100644 --- a/docs/_build/html/_sources/api/tcutility.rst.txt +++ b/docs/_build/html/_sources/api/tcutility.rst.txt @@ -8,6 +8,7 @@ Subpackages :maxdepth: 4 tcutility.analysis + tcutility.data tcutility.job tcutility.results tcutility.typing diff --git a/docs/_build/html/api/modules.html b/docs/_build/html/api/modules.html index 26b67fcb..50755c12 100644 --- a/docs/_build/html/api/modules.html +++ b/docs/_build/html/api/modules.html @@ -216,7 +216,11 @@
  • tcutility.analysis.vibration package
  • -
  • tcutility.job package
  • +
  • tcutility.data package +
  • tcutility.job package
  • Module contents
      diff --git a/docs/_build/html/api/tcutility.analysis.html b/docs/_build/html/api/tcutility.analysis.html index 2bfc01e8..9581c66e 100644 --- a/docs/_build/html/api/tcutility.analysis.html +++ b/docs/_build/html/api/tcutility.analysis.html @@ -216,7 +216,11 @@
    • tcutility.analysis.vibration package
  • -
  • tcutility.job package
  • -
  • tcutility.job package
  • -
  • tcutility.job package
      +
    • tcutility.data package +
    • +
    • tcutility.job package
    • @@ -387,11 +391,11 @@

      Submodules

      next

      -

      tcutility.job package

      +

      tcutility.data package

      diff --git a/docs/_build/html/api/tcutility.data.atom_data_info.html b/docs/_build/html/api/tcutility.data.atom_data_info.html new file mode 100644 index 00000000..0b43783b --- /dev/null +++ b/docs/_build/html/api/tcutility.data.atom_data_info.html @@ -0,0 +1,418 @@ + + + + + + + + + + + tcutility.data.atom_data_info package — TCutility v0.8.5 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + +
      +
      +
      +
      +
      + + + + +
      +
      + + + + + +
      + + +
      +
      + +
      +
      + +
      + +
      + + + + + + +
      + +
      + + +
      +
      + + + + + +
      + +
      +

      tcutility.data.atom_data_info package#

      +
      +

      Module contents#

      +
      +
      + + +
      + + + + + + + +
      + + + +
      + + +
      +
      + +
      + +
      +
      +
      + + + + + +
      + + +
      + + \ No newline at end of file diff --git a/docs/_build/html/api/tcutility.data.html b/docs/_build/html/api/tcutility.data.html new file mode 100644 index 00000000..45c13d0b --- /dev/null +++ b/docs/_build/html/api/tcutility.data.html @@ -0,0 +1,589 @@ + + + + + + + + + + + tcutility.data package — TCutility v0.8.5 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + +
      +
      +
      +
      +
      + + + + +
      +
      + + + + + +
      + + +
      +
      + +
      +
      + +
      + +
      + + + + +
      + +
      + + +
      +
      + + + + + +
      + +
      +

      tcutility.data package#

      +
      +

      Subpackages#

      + +
      +
      +

      Submodules#

      +
      +
      +

      tcutility.data.atom module#

      +
      +
      +parse_element(val)[source]#
      +

      Parse a str or int to an atom number.

      +
      +
      Parameters:
      +

      val – Element name, symbol or atom number.

      +
      +
      Returns:
      +

      Atom number corresponding to val.

      +
      +
      +

      Examples

      +
      parse_element('Hydrogen') == 1
      +parse_element('C') == 6
      +parse_element(23) == 23
      +
      +
      +
      + +
      +
      +radius(element)[source]#
      +
      +
      Parameters:
      +

      element – the symbol, name or atom number of the element. See parse_element().

      +
      +
      Returns:
      +

      The empirical covalent radius of an element in angstroms, up to element 96.

      +
      +
      +
      + +
      +
      +color(element)[source]#
      +
      +
      Parameters:
      +

      element – the symbol, name or atom number of the element. See parse_element().

      +
      +
      Returns:
      +

      The standard CPK colors of the elements, up to element 109.

      +
      +
      +
      + +
      +
      +

      tcutility.data.basis_sets module#

      +
      +
      +

      tcutility.data.cosmo module#

      +
      +
      +

      tcutility.data.functionals module#

      +
      +
      +get(functional_name: str) Result[source]#
      +

      Return information about a given functional.

      +
      +
      Parameters:
      +

      functional_name – the name of the functional. It should exist in the get_available_functionals() keys.

      +
      +
      Returns:
      +

      A |Result| object containing information about the functional if it exists. Else it will return None.

      +
      +
      +
      +

      See also

      +

      get_available_functionals() for an overview of the information returned.

      +
      +
      + +
      +
      +functional_name_from_path_safe_name(path_safe_name: str) Result[source]#
      +

      Return information about a given functional given its path-safe name. +This can be useful when you want to know the functional from a path name.

      +
      +
      Returns:
      +

      A |Result| object containing information about the functional if it exists. Else it will return None.

      +
      +
      +
      +

      See also

      +

      get_available_functionals() for an overview of the information returned.

      +
      +
      + +
      +
      +get_available_functionals()[source]#
      +

      Function that returns a dictionary of all available XC-functionals.

      +
      +
      Returns:
      +

      +
      A |Result| object containing information about all available XC-functionals.

      The functional names are stored as the keys and the functional information is stored as the values. +The values contain the following information:

      +
      +
        +
      • name (str) - the name of the functional.

      • +
      • +
        path_safe_name (str) - the name of the functional made suitable for file paths.

        This name is the same as the normal name, but without parentheses. Asterisks are replaced with lower-case s.

        +
        +
        +
      • +
      • name_no_disp (str) - the name of functional without the dispersion correction.

      • +
      • category (str) - the category the functional belongs to.

      • +
      • dispersion (str) - the dispersion correction part of the functional name.

      • +
      • dispersion_name (str) - the name of the dispersion correction as it would be written in ADF.

      • +
      • includes_disp (bool) - whether the functional already includes a dispersion correction.

      • +
      • use_libxc (bool) - whether the functional is from the LibXC library.

      • +
      • available_in_adf (bool) - whether the functional is available in ADF.

      • +
      • available_in_band (bool) - whether the functional is available in BAND.

      • +
      • available_in_orca (bool) - whether the functional is available in ORCA.

      • +
      • adf_settings (|Result|) - the settings that are used to select the functional in the ADF input.

      • +
      +
      +
      +
      +

      +
      +
      +
      + +
      +
      +

      tcutility.data.molecules module#

      +
      +
      +get(name)[source]#
      +
      + +
      +
      +get_molecules(tags=None)[source]#
      +
      + +
      +
      +

      Module contents#

      +
      +
      + + +
      + + + + + + + +
      + + + + + + +
      +
      + +
      + +
      +
      +
      + + + + + +
      + + +
      + + \ No newline at end of file diff --git a/docs/_build/html/api/tcutility.html b/docs/_build/html/api/tcutility.html index c5e3a3e1..0a984dcf 100644 --- a/docs/_build/html/api/tcutility.html +++ b/docs/_build/html/api/tcutility.html @@ -217,7 +217,11 @@
    • tcutility.analysis.vibration package
  • -
  • tcutility.job package
  • +
  • tcutility.data package +
  • tcutility.job package
    • Subpackages + -
      • get_memory_usage() (ORCAJob method)
      • -
      • get_molecules() (in module tcutility.results.ams) +
      • get_molecules() (in module tcutility.data.molecules)
      • @@ -629,6 +645,20 @@

        M

      • tcutility.cache
      • tcutility.constants +
      • +
      • tcutility.data +
      • +
      • tcutility.data.atom +
      • +
      • tcutility.data.atom_data_info +
      • +
      • tcutility.data.basis_sets +
      • +
      • tcutility.data.cosmo +
      • +
      • tcutility.data.functionals +
      • +
      • tcutility.data.molecules
      • tcutility.formula
      • @@ -753,12 +783,14 @@

        O

        P

          +
        • parse_str() (in module tcutility.molecule) +
        • plot_vdd_charges_per_atom() (VDDChargeManager method)
        • prune() (Result method) @@ -783,6 +815,8 @@

          Q

          R

          + - + + + + + + + + + + + + + + + + + + + + +
          +
          • tcutility.job.nmr @@ -1025,8 +1110,6 @@

            T

          • module
          -
          • tcutility.job.postscripts.clean_workdir diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv index 350d8bc3..ead49c5b 100644 Binary files a/docs/_build/html/objects.inv and b/docs/_build/html/objects.inv differ diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html index 37b539a1..a56d9cfd 100644 --- a/docs/_build/html/py-modindex.html +++ b/docs/_build/html/py-modindex.html @@ -277,6 +277,41 @@

            Python Module Index

              tcutility.constants
              + tcutility.data +
              + tcutility.data.atom +
              + tcutility.data.atom_data_info +
              + tcutility.data.basis_sets +
              + tcutility.data.cosmo +
              + tcutility.data.functionals +
              + tcutility.data.molecules +
              diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 1018decf..47797d3a 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["analysis/analysis", "analysis/transition_state_analysis", "analysis/vdd_charge_analysis", "api/modules", "api/tcutility", "api/tcutility.analysis", "api/tcutility.analysis.vdd", "api/tcutility.analysis.vibration", "api/tcutility.atom_data_info", "api/tcutility.job", "api/tcutility.job.postscripts", "api/tcutility.results", "api/tcutility.typing", "examples", "index", "tcutility.constants", "tcutility.job", "tcutility.results"], "filenames": ["analysis/analysis.rst", "analysis/transition_state_analysis.rst", "analysis/vdd_charge_analysis.rst", "api/modules.rst", "api/tcutility.rst", "api/tcutility.analysis.rst", "api/tcutility.analysis.vdd.rst", "api/tcutility.analysis.vibration.rst", "api/tcutility.atom_data_info.rst", "api/tcutility.job.rst", "api/tcutility.job.postscripts.rst", "api/tcutility.results.rst", "api/tcutility.typing.rst", "examples.rst", "index.rst", "tcutility.constants.rst", "tcutility.job.rst", "tcutility.results.rst"], "titles": ["Overview of the analysis module", "Transition State Analysis module", "VDD Charge Analysis module", "tcutility", "tcutility package", "tcutility.analysis package", "tcutility.analysis.vdd package", "tcutility.analysis.vibration package", "tcutility.atom_data_info package", "tcutility.job package", "tcutility.job.postscripts package", "tcutility.results package", "tcutility.typing package", "Examples", "TCutility v0.8.5 documentation", "tcutility.constants package", "Setup workflows with tcutility.job", "Reading a calculation"], "terms": {"thi": [0, 1, 2, 4, 7, 9, 11, 14, 16, 17], "chapter": 0, "contain": [0, 1, 2, 4, 7, 9, 11, 14, 15], "descript": [0, 4], "all": [0, 4, 7, 9, 16], "function": [0, 2, 4, 7, 9, 11, 14, 16, 17], "includ": [0, 2, 4, 11, 16, 17], "exampl": [0, 1, 4, 9, 11], "usag": [0, 4, 11, 16, 17], "below": [0, 4, 11, 16, 17], "i": [0, 1, 2, 4, 6, 7, 9, 11, 14, 16, 17], "list": [0, 2, 4, 6, 7, 9, 11], "avail": [0, 4, 6, 9, 16], "transit": [0, 7, 9, 14], "state": [0, 7, 9, 14], "vdd": [0, 1, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "charg": [0, 1, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "requir": 0, "api": [0, 16], "tcutil": [0, 1, 2, 17], "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17], "read": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "manag": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "vddchargemanag": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "vddcharg": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "change_unit": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "v0": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17], "7": 2, "2": [2, 4, 9, 11, 16], "text": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "cm": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "1": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "kcal": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "mol": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "km": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "code": [1, 4, 11, 14, 16], "document": [1, 4, 9, 16], "still": [1, 4, 9], "under": [1, 14], "construct": [1, 9], "when": [2, 4, 9, 11, 16], "calcul": [2, 4, 7, 9, 11, 14, 16], "perform": [2, 11], "ha": [2, 4, 7, 9, 11], "succesfulli": [2, 9], "finish": [2, 3, 4, 9, 11, 16], "can": [2, 4, 6, 9, 11, 16, 17], "us": [2, 4, 6, 7, 9, 11, 14, 15, 16, 17], "extract": 2, "voronoi": [2, 11], "deform": [2, 11], "densiti": [2, 9, 16], "The": [2, 4, 6, 9, 11, 16, 17], "measur": 2, "flow": [2, 3, 4], "between": [2, 4, 7, 9, 11, 16], "atom": [2, 4, 7, 9, 11, 16], "offici": 2, "cell": 2, "from": [2, 4, 6, 7, 9, 11, 16, 17], "non": [2, 11], "interact": [2, 11], "promolecul": 2, "feel": 2, "environ": 2, "other": [2, 4, 9], "molecular": [2, 4, 9, 11], "enviro": 2, "If": [2, 4, 7, 9, 11, 16], "symmetri": [2, 7, 11, 17], "decompos": [2, 11], "contribut": [2, 11], "seper": 2, "irreduc": 2, "represent": [2, 4], "A": [2, 4, 9, 15, 16], "adf": [2, 3, 4, 16, 17], "engin": [2, 11, 17], "locat": [2, 11], "directori": [2, 4, 9, 11, 16], "am": [2, 3, 4, 7, 16, 17], "rkf": [2, 7, 9, 11], "file": [2, 4, 6, 7, 9, 11, 16], "first": [2, 4, 7, 9, 11, 16], "relev": [2, 11], "need": [2, 9, 16], "load": [2, 3, 4, 9, 16], "These": [2, 4, 11], "pathlib": 2, "handl": [2, 4, 9, 11, 16], "path": [2, 4, 6, 7, 9, 11, 16], "In": [2, 4, 9, 11, 16], "addit": [2, 9], "which": [2, 4, 9, 11, 16], "interfac": 2, "analys": [2, 4, 11], "For": [2, 4, 9, 11, 16], "we": [2, 4, 9, 11, 16], "found": [2, 7, 9], "test": [2, 9, 11, 17], "packag": [2, 3, 14, 16, 17], "assum": [2, 4], "you": [2, 4, 9, 11, 16, 17], "place": [2, 4, 9], "same": [2, 4, 6, 9, 11, 16], "script": [2, 9, 16], "see": [2, 4, 9, 11, 16], "python": [2, 9, 11, 14], "direct": [2, 9], "implement": [2, 9], "import": [2, 4, 9, 11, 16, 17], "pl": 2, "now": 2, "specifi": [2, 4, 6, 9, 16], "via": 2, "next": 2, "step": [2, 4, 9, 11], "creat": [2, 4, 6, 9, 11], "object": [2, 4, 6, 7, 9, 11, 17], "dir": 2, "0": [2, 4, 7, 9, 11, 16, 17], "fa_acid_amide_c": 2, "fa_squaramide_se_c": 2, "fa_donor_acceptor_nosym": 2, "3": [2, 4, 11], "geo_nosym": 2, "base_dir": 2, "__file__": 2, "parent": [2, 9, 11], "calc_dir": [2, 5, 6, 7, 11, 16, 17], "calc_r": 2, "vdd_manag": 2, "create_vdd_charge_manag": [2, 5, 6], "name": [2, 4, 5, 6, 9, 11, 16], "total": [2, 6, 11, 17], "well": [2, 4, 11, 16, 17], "each": [2, 4, 6, 9, 11], "To": [2, 9, 16], "content": [2, 3], "simpli": [2, 4, 16], "print": [2, 4, 6, 16], "ar": [2, 4, 6, 7, 9, 11, 16], "format": [2, 4, 7, 9, 11, 16], "tabl": [2, 3, 4, 6], "unit": [2, 4, 5, 6, 9], "milli": 2, "electron": [2, 4, 6, 11], "me": [2, 6], "alwai": [2, 4, 9], "chang": [2, 4, 6, 7, 9, 16], "method": [2, 4, 6, 9, 11, 16], "e": [2, 4, 6, 9, 11, 17], "standard": [2, 11], "output": [2, 4, 9, 11], "frag": [2, 4, 16], "aa": [2, 11, 17], "aaa": [2, 11, 17], "1c": 2, "40": [2, 4], "10": [2, 4, 9, 16], "30": [2, 4], "2se": 2, "165": 2, "134": 2, "3c": [2, 9], "4se": 2, "5c": 2, "26": [2, 4], "122": 2, "96": 2, "6c": 2, "7n": 2, "62": 2, "88": 2, "150": 2, "8h": 2, "53": 2, "55": 2, "9h": 2, "63": 2, "56": 2, "10n": 2, "11h": 2, "12h": 2, "sum": [2, 6, 11], "357": 2, "164": 2, "521": 2, "It": [2, 4, 6, 9, 11, 16], "easi": [2, 16], "up": [2, 4, 9, 16], "molecul": [2, 3, 6, 7, 9, 11, 16], "case": [2, 4, 9, 11, 16], "also": [2, 4, 9, 11, 16, 17], "irrep": [2, 5, 6, 11], "equal": [2, 9, 11], "should": [2, 4, 7, 9, 11], "possibl": [2, 4, 7, 11, 16], "both": [2, 4, 9], "txt": 2, "excel": [2, 6], "xlsx": 2, "further": [2, 4, 11], "output_dir": [2, 6], "write": [2, 6, 9], "static": [2, 6], "becaus": [2, 6], "multipl": [2, 4, 6, 7, 9, 11], "written": [2, 4, 6, 9, 11, 14], "write_to_txt": [2, 5, 6], "an": [2, 4, 6, 9, 11, 16], "write_to_excel": [2, 5, 6], "visual": 2, "plot": [2, 6], "bar": [2, 4, 6], "graph": [2, 6], "matplotlib": 2, "save": [2, 3, 4, 16], "png": 2, "per": [2, 6, 11], "plot_vdd_charges_per_atom": [2, 5, 6], "final": [2, 11], "made": [2, 4], "singl": [2, 4, 9, 11, 16], "compar": [2, 4, 7], "combin": [2, 4], "calc": 2, "valu": [2, 4, 7, 9, 11], "re": [2, 11], "zip": 2, "19": 2, "18": 2, "2o": 2, "8": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17], "49": 2, "41": 2, "3se": 2, "68": 2, "5": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17], "4o": 2, "34": 2, "27": 2, "61": 2, "6h": 2, "6": [2, 4, 11, 16], "7h": 2, "4": [2, 4], "44": 2, "9n": 2, "46": 2, "42": 2, "10h": 2, "32": [2, 16], "31": 2, "2c": 2, "4c": 2, "5h": 2, "12o": 2, "13o": 2, "14n": 2, "13": 2, "15h": 2, "16h": 2, "17h": 2, "9": 2, "18h": 2, "20": [2, 4], "105": 2, "2h": 2, "67": 2, "11": 2, "3h": 2, "16": [2, 16], "4h": 2, "17": [2, 11, 17], "166": 2, "6o": 2, "291": 2, "116": 2, "158": 2, "21": 2, "84": 2, "11c": 2, "213": 2, "253": 2, "13n": 2, "235": 2, "14h": 2, "54": 2, "14": 2, "59": 2, "15": [2, 4], "16c": 2, "45": 2, "22": 2, "17c": 2, "23": 2, "18c": 2, "50": [2, 4], "24": 2, "19c": 2, "25": 2, "20c": 2, "21c": 2, "64": 2, "12": 2, "22h": 2, "65": 2, "23h": 2, "52": 2, "24h": 2, "48": 2, "25h": 2, "here": [2, 9, 16], "class": [2, 4, 6, 9, 11, 14], "central": 2, "inform": [2, 4, 11, 17], "dictionari": [2, 4, 11], "present": [2, 4, 11], "kei": [2, 4, 11], "doe": [2, 4, 9, 16], "onli": [2, 4, 7, 11], "itself": [2, 11], "index": [2, 4, 7, 11, 14], "belong": [2, 4, 11], "subpackag": 3, "analysi": [3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "modul": [3, 16], "job": [3, 4, 11], "submodul": [3, 5, 17], "crest": [3, 4, 16], "dftb": [3, 4, 16, 17], "gener": [3, 4, 11, 16], "nmr": [3, 4, 16], "orca": [3, 4, 16], "cach": 3, "type": [3, 4, 9, 11], "arrai": [3, 4, 7, 11], "timed_cach": [3, 4], "constant": [3, 9, 14], "formula": 3, "parse_molecul": [3, 4], "geometri": [3, 9, 11, 16], "transform": [3, 4, 11], "appli": [3, 4, 7, 16], "combine_transform": [3, 4], "translat": [3, 4], "rotat": [3, 4], "scale": [3, 4, 11], "kabschtransform": [3, 4], "get_rotmat": [3, 4], "apply_rotmat": [3, 4], "vector_align_rotmat": [3, 4], "rmsd": [3, 4], "random_points_on_spher": [3, 4], "random_points_in_anular_spher": [3, 4], "log": 3, "emoji": [3, 4], "wait": [3, 4, 9, 16], "good": [3, 4, 9, 16], "cancel": [3, 4, 9], "sleep": [3, 4], "fail": [3, 4, 9, 11], "send": [3, 4], "receiv": [3, 4], "empti": [3, 4, 9, 11], "warn": [3, 4, 11], "question": [3, 4], "info": [3, 4, 11, 17], "rarrow": [3, 4], "larrow": [3, 4], "lrarrow": [3, 4], "rlarrow": [3, 4], "angstrom": [3, 4, 9], "noprint": [3, 4], "time_stamp": [3, 4], "loadbar": [3, 4], "box": [3, 4], "debug": [3, 4], "error": [3, 4, 11, 16], "critic": [3, 4], "caller_nam": [3, 4], "parse_str": [3, 4], "guess_frag": [3, 4, 16], "report": 3, "si": [3, 4], "add_xyz": [3, 4], "add_head": [3, 4], "slurm": [3, 9], "has_slurm": [3, 4], "squeue": [3, 4, 9], "sbatch": [3, 4, 9, 16], "workdir_info": [3, 4], "wait_for_job": [3, 4], "ensure_list": [3, 4], "squeeze_list": [3, 4], "ensure_2d": [3, 4], "vibrat": [4, 5, 9, 11, 17], "ts_vibrat": [4, 5], "adfjob": [4, 9, 16], "basis_set": [4, 9, 16], "spin_polar": [4, 9, 11], "unrestrict": [4, 9, 11], "qualiti": [4, 9, 11, 16], "scf_converg": [4, 9], "rel": [4, 7, 9], "solvent": [4, 9], "adffragmentjob": [4, 9, 16], "add_frag": [4, 9, 16], "run": [4, 9, 11, 16], "amsjob": [4, 9], "single_point": [4, 9], "geometry_converg": [4, 9], "transition_st": [4, 9], "optim": [4, 9, 11, 16], "output_mol_path": [4, 9], "crestjob": [4, 9, 16], "md_temperatur": [4, 9], "md_length": [4, 9], "best_conformer_path": [4, 9], "conformer_directori": [4, 9], "rotamer_directori": [4, 9], "get_conformer_xyz": [4, 9, 16], "get_rotamer_xyz": [4, 9], "qcgjob": [4, 9, 16], "nsolv": [4, 9], "alpb": [4, 9], "ensemble_mod": [4, 9], "nofix": [4, 9], "ensemble_directori": [4, 9], "get_ensemble_xyz": [4, 9], "best_ensemble_path": [4, 9], "dftbjob": [4, 9, 16], "kspace": [4, 9], "model": [4, 9, 16], "can_skip": [4, 9], "add_preambl": [4, 9], "add_postambl": [4, 9], "depend": [4, 9, 11], "workdir": [4, 9, 16], "runfile_path": [4, 9], "inputfile_path": [4, 9], "nmrjob": [4, 9, 16], "add_nics_point": [4, 9], "orcajob": [4, 9, 16], "get_memory_usag": [4, 9], "get_input": [4, 9, 11], "get_calc_set": [4, 11], "get_properti": [4, 11], "get_level_of_theori": [4, 11], "get_calc_fil": [4, 11], "get_ams_vers": [4, 11], "get_ams_info": [4, 11], "get_tim": [4, 11], "get_calculation_statu": [4, 11], "get_molecul": [4, 11], "get_histori": [4, 11], "get_input_block": [4, 11], "get_ams_input": [4, 11], "trackkfread": [4, 11], "store": [4, 11], "get": [4, 6, 11, 16], "unload": [4, 11], "get_vers": [4, 11], "get_info": [4, 11], "get_vibr": [4, 11], "item": [4, 11, 16], "get_parent_tre": [4, 11], "prune": [4, 11], "get_multi_kei": [4, 11], "as_plams_set": [4, 11], "delai": 4, "float": [4, 6, 7, 9, 11], "sourc": [4, 6, 7, 9, 11], "decor": 4, "time": [4, 11], "expir": 4, "after": [4, 9, 11], "chosen": [4, 11], "amount": [4, 11], "paramet": [4, 7, 9, 11], "expiri": 4, "func": [4, 6], "previou": 4, "call": [4, 9, 11, 17], "str": [4, 6, 7, 9, 11], "return": [4, 7, 9, 11], "molstr": 4, "describ": [4, 11], "its": [4, 11], "part": 4, "separ": 4, "sign": [4, 7], "new": [4, 9, 11, 16], "string": [4, 11], "plam": [4, 7, 9, 11], "pars": [4, 11], "mode": [4, 7, 9, 11], "unicod": 4, "show": 4, "properli": 4, "latex": 4, "html": [4, 11], "either": [4, 11], "reaction": [4, 7, 9], "formatt": 4, "convert": [4, 11], "render": 4, "nice": [4, 6], "base": [4, 6, 7, 9, 11, 16], "matrix": 4, "set": [4, 9, 11, 16, 17], "3d": 4, "coordin": [4, 7, 9, 11], "build": [4, 9, 16], "4x4": 4, "encod": 4, "textbf": 4, "m": 4, "begin": 4, "bmatrix": 4, "r": [4, 11], "diag": 4, "": [4, 9, 11, 17], "t": [4, 9, 16], "_3": 4, "end": [4, 11], "where": [4, 11, 16], "mathbb": 4, "x": [4, 9], "y": [4, 9], "z": [4, 9], "n": [4, 11, 16], "simultan": 4, "v": 4, "ndarrai": [4, 7], "vector": 4, "applic": 4, "three": [4, 16], "process": [4, 11], "append": 4, "row": 4, "ones": [4, 9], "bottom": 4, "remov": [4, 9, 11], "been": 4, "__call__": 4, "redirect": [4, 9], "coord": 4, "two": [4, 6, 11], "differ": [4, 7, 11, 16], "involv": 4, "multipli": [4, 9], "matric": 4, "assign": 4, "one": [4, 7, 9, 11, 16, 17], "product": 4, "origin": 4, "left": 4, "side": 4, "right": 4, "__matmul__": 4, "none": [4, 6, 7, 9, 11], "add": [4, 9, 11, 16], "compon": 4, "argument": [4, 7, 9], "given": [4, 7, 9, 11, 16, 17], "thei": [4, 11, 16], "3x3": 4, "angl": [4, 9], "along": 4, "ax": 4, "kabsch": 4, "umeyama": 4, "algorithm": 4, "t_": 4, "minim": [4, 9], "arg": [4, 9, 11], "min_": 4, "numer": [4, 9, 11], "stabl": 4, "work": [4, 9, 11, 14, 16], "covari": 4, "singular": 4, "point": [4, 7, 9, 11, 16], "must": [4, 9], "size": [4, 9, 11], "center": 4, "onto": 4, "centroid": 4, "befor": [4, 7, 9, 16], "determin": [4, 7, 16], "yield": [4, 7], "second": [4, 7], "target": 4, "principl": [4, 9], "care": 4, "about": [4, 11], "dimens": 4, "howev": 4, "our": [4, 16], "most": 4, "common": [4, 11, 16], "would": [4, 9, 16], "like": [4, 9, 11, 16, 17], "make": [4, 9, 16], "2d": 4, "1d": [4, 11], "suggest": 4, "correct": [4, 9, 11, 16], "zero": [4, 9], "main": [4, 11], "numpi": [4, 11], "np": 4, "arang": 4, "reshap": 4, "tx": 4, "tkabsch": 4, "check": [4, 6, 7, 9, 11], "assert": 4, "isclos": 4, "refer": [4, 11, 16], "http": [4, 11], "en": 4, "wikipedia": 4, "org": [4, 11], "wiki": 4, "orthogonal_procrustes_problem": 4, "kabsch_algorithm": 4, "tait": 4, "bryant": 4, "sytem": 4, "system": [4, 9, 11], "around": 4, "correspond": [4, 11], "hand": 4, "convent": [4, 7], "axi": 4, "radian": 4, "directli": 4, "allow": [4, 11, 16], "math": 4, "b": [4, 16], "align": 4, "int": [4, 6, 7, 9, 11], "use_kabsch": 4, "bool": [4, 6, 7, 9, 11], "true": [4, 7, 9, 11], "root": 4, "mean": [4, 9], "squar": 4, "deviat": 4, "By": [4, 9], "default": [4, 7, 9], "prior": [4, 9], "option": [4, 7, 9, 11, 16], "frac": 4, "sqrt": [4, 9], "sum_i": 4, "x_i": 4, "y_i": 4, "obtain": [4, 7, 11], "have": [4, 9, 11], "whether": [4, 7, 9, 11], "integ": [4, 11], "recommend": [4, 11, 17], "enabl": [4, 9, 11, 17], "ensur": [4, 16], "lowest": [4, 7, 16], "shape": 4, "tupl": [4, 9], "radiu": [4, 9], "random": 4, "sphere": 4, "min_radiu": 4, "max_radiu": 4, "radii": [4, 9], "largest": 4, "some": [4, 9, 15, 16], "charact": [4, 11], "support": [4, 9], "dot": [4, 11], "notat": [4, 11], "g": [4, 9, 11, 17], "\u2139": 4, "\u00e5": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "stdout": 4, "stderr": 4, "context": [4, 9, 16], "suppress": 4, "temporari": 4, "delet": [4, 11], "exit": [4, 16], "current": [4, 16], "timestamp": 4, "yyyi": 4, "mm": 4, "dd": 4, "hh": 4, "ss": 4, "messag": 4, "tag": 4, "straight": 4, "level": [4, 9, 11, 16], "flowchart": 4, "prepend": 4, "element": [4, 7, 11], "arrow": 4, "line": [4, 9, 11, 16], "ani": [4, 9, 11, 16], "header": 4, "sep": 4, "hline": 4, "cast": 4, "nrow": 4, "sequenc": [4, 6, 9], "ncol": 4, "data": [4, 7, 11], "insid": [4, 11], "repres": 4, "column": 4, "top": 4, "drawn": 4, "neg": [4, 7, 9], "indic": [4, 9, 11], "draw": 4, "iter": 4, "comment": 4, "nsegment": 4, "nstep": 4, "progress": 4, "over": [4, 9], "defin": [4, 7, 11, 16], "__len__": 4, "give": [4, 9, 11], "length": [4, 7, 9], "number": [4, 7, 9, 11, 16], "dure": [4, 9, 11], "tty": 4, "stream": 4, "titl": 4, "message_align": 4, "title_align": 4, "round_corn": 4, "double_edg": 4, "fals": [4, 7, 9, 11], "surround": 4, "multilin": 4, "edg": 4, "One": [4, 11, 16, 17], "corner": 4, "round": 4, "doubl": 4, "full": [4, 9, 11, 16, 17], "caller": 4, "skip": [4, 9, 11], "formatte": 4, "multi": 4, "split": 4, "escap": 4, "verbos": 4, "follow": [4, 9, 11, 16], "notset": 4, "__str__": 4, "dict": [4, 6, 11, 17], "json": 4, "against": [4, 7], "wide": 4, "log_level": 4, "variabl": [4, 11], "do": [4, 16], "usual": [4, 9], "custom": 4, "xyz": [4, 9, 16], "flag": 4, "provid": [4, 7, 9, 11], "structur": [4, 11, 16], "atom_tag1": 4, "atom_tag2": 4, "atom_key1": 4, "mol_tag1": 4, "mol_tag2": 4, "mol_key1": 4, "mol_key2": 4, "respect": 4, "similarli": 4, "guess": [4, 11], "fragment": [4, 6, 11, 16], "tab": 4, "00000000": [4, 16], "81474153": [4, 16], "83567034": [4, 16], "h": [4, 16], "47608351": [4, 16], "82460084": [4, 16], "14410295": [4, 16], "95216703": [4, 16], "58149793": [4, 16], "00718395": [4, 16], "13712667": [4, 16], "16299585": [4, 16], "frag_donor": 4, "frag_acceptor": 4, "prefix": 4, "frag_": 4, "rang": 4, "donor": [4, 16], "acceptor": [4, 16], "mark": 4, "shown": 4, "abov": [4, 9], "were": [4, 11], "obj": 4, "bond": [4, 7, 11], "energi": [4, 9, 11, 17], "gibb": [4, 11], "free": [4, 11], "enthalpi": [4, 11], "imaginari": [4, 7, 9, 11], "head": 4, "docx": 4, "platform": [4, 16], "statu": [4, 9, 11], "id": [4, 9, 11], "statuscod": 4, "lessen": 4, "hpc": 4, "runfil": [4, 9], "submit": [4, 9, 16], "filenam": [4, 11], "command": 4, "being": [4, 11], "activ": [4, 7], "referenc": 4, "slurmid": 4, "check_everi": 4, "everi": 4, "again": 4, "don": [4, 16], "put": 4, "too": 4, "high": [4, 11], "anger": 4, "cluster": [4, 16], "peopl": 4, "transpos": 4, "atom_index": [5, 6], "atom_symbol": [5, 6, 11], "frag_index": [5, 6], "change_unit_decor": [5, 6], "vdd_charg": [5, 6], "is_fragment_calcul": [5, 6], "mol_charg": [5, 6], "charge_is_conserv": [5, 6], "get_vdd_charg": [5, 6], "get_summed_vdd_charg": [5, 6], "get_vdd_charges_datafram": [5, 6], "get_summed_vdd_charges_datafram": [5, 6], "get_vdd_charges_t": [5, 6], "get_summed_vdd_charges_t": [5, 6], "avg_relative_bond_length_delta": [5, 7], "determine_ts_reactioncoordin": [5, 7], "validate_transitionst": [5, 7], "ratio": 6, "them": [6, 9, 11], "conserv": 6, "new_unit": 6, "mili": 6, "datafram": 6, "panda": 6, "output_fil": 6, "sheet": 6, "po": 7, "atom1": 7, "atom2": 7, "distanc": [4, 7, 9], "ad": [7, 11], "subtract": 7, "label": [7, 11, 17], "averag": 7, "baselin": 7, "select": [7, 9, 11], "percentag": 7, "mode_index": 7, "bond_toler": 7, "28": 7, "min_delta_dist": 7, "retriev": [7, 11, 17], "transitionst": [7, 11], "frequenc": [7, 9, 11], "analyz": 7, "guess_bond": 7, "minimum": [7, 11], "qualifi": 7, "count": [7, 9], "active_atom1": 7, "active_atom2": 7, "reactioncoordin": 7, "ignor": [4, 7], "increas": 7, "rcatom": 7, "analyze_mod": 7, "kwarg": [4, 7, 9, 11], "expect": [7, 11], "user": [7, 11], "input": [4, 7, 9, 11, 16], "section": [7, 11], "desir": [7, 11], "atomlabel1": 7, "atomlabel2": 7, "order": [7, 11], "keyword": 7, "boolean": 7, "otherwis": [7, 9, 11, 16], "least": 7, "typ": 9, "tz2p": [9, 16], "core": [9, 11, 16], "basi": [9, 11], "frozen": [9, 11], "approxim": [9, 11], "r2scan": 9, "mtz2p": 9, "val": 9, "spin": [9, 11], "polar": [9, 11], "singlet": 9, "doublet": 9, "triplet": 9, "gui": [9, 16], "thresh": 9, "1e": 9, "08": 9, "scf": [9, 11], "converg": 9, "criteria": 9, "procedur": 9, "funtional_nam": 9, "dispers": [9, 11], "pleas": [9, 16], "get_available_funct": 9, "want": [9, 11, 16], "libxc": 9, "automat": [9, 11, 16], "scalar": 9, "treatment": 9, "relativist": [9, 11], "effect": [9, 11], "ep": 9, "rad": 9, "use_klamt": 9, "solvat": [9, 16], "cosmo": 9, "manual": 9, "dielectr": 9, "your": [9, 16], "more": [4, 9, 16], "control": [9, 16], "klamt": 9, "speci": 9, "detect": [9, 16], "local": [9, 16], "serv": 9, "futur": 9, "bandjob": 9, "hold": 9, "relat": [9, 11, 16], "prepar": [9, 16], "task": [9, 11, 16], "gradient": [9, 11], "05": 9, "dihedr": 9, "modetofollow": 9, "search": [9, 14, 16], "acceler": 9, "normal": 9, "atom_index1": 9, "atom_index2": 9, "factor": 9, "start": [9, 11, 16], "atom_index3": 9, "atom_index4": 9, "pespointcharact": [], "negativefrequenciestoler": 9, "rescanfreqrang": [], "10000000": [], "pe": 11, "toler": 9, "experi": 9, "lot": 9, "nois": 9, "rescan": [], "refin": [], "properti": [9, 11, 16, 17], "singlepoint": [9, 11], "temperatur": 9, "dynam": 9, "400k": 9, "conform": [9, 16], "alreadi": 9, "exist": [4, 9, 16], "wa": [9, 11], "rotam": [9, 16], "setup": 9, "tight": [9, 16], "bind": [9, 16], "amsterdam": [9, 16], "suit": [9, 16], "k": 9, "space": 9, "integr": 9, "gfn1": 9, "xtb": 9, "parameter_dir": 9, "hamiltonian": 9, "grid_siz": 9, "974": 9, "gbsa": 9, "aceton": 9, "acetonitril": 9, "chcl3": 9, "cs2": 9, "dmso": 9, "ether": 9, "h2o": 9, "methanol": 9, "thf": 9, "toluen": 9, "grid": 9, "access": [9, 11, 16, 17], "surfac": 9, "230": 9, "2030": 9, "5810": 9, "test_mod": 9, "overwrit": 9, "wait_for_finish": 9, "advanc": 9, "__enter__": 9, "__exit__": 9, "syntax": 9, "safe": 9, "_setup_job": 9, "overwritten": 9, "know": [9, 16], "what": 9, "look": 9, "real": 9, "previous": 9, "continu": 9, "runscript": [9, 16], "fatal": [9, 11], "could": [4, 9], "those": 9, "yet": [9, 11, 16], "latter": 9, "rerun": 9, "fix": 9, "later": [9, 11], "version": [9, 11, 14], "partit": [9, 16], "tc": [9, 16], "p": [9, 16], "note": 9, "dash": 9, "cannot": [9, 11], "underscor": 9, "job_nam": 9, "water_dimer_go": 9, "few": [9, 16], "extra": [9, 11], "d": [9, 11], "chdir": 9, "self": 9, "sure": 9, "j": 9, "rundir": [9, 16], "nicer": 9, "o": [9, 16], "out": [9, 11], "wish": 9, "preambl": 9, "come": 9, "shebang": 9, "ran": [9, 16], "program": [9, 11, 14], "specif": [9, 11, 16, 17], "2023": 9, "101": 9, "postambl": 9, "copi": 9, "t12": 9, "rm": 9, "otherjob": 9, "anoth": [9, 16], "sens": 9, "back": 9, "variou": [4, 9, 16], "nuclear": [9, 11, 16], "magnet": [9, 16], "reson": [9, 16], "chemic": 9, "shift": 9, "saop": 9, "theori": [9, 11, 16], "nic": 9, "cartesian": 9, "relativistic_typ": 11, "unrestricted_sfo": 11, "sfo": 11, "treat": 11, "manner": 11, "unrestricted_mo": 11, "mo": 11, "group": [11, 14, 17], "associ": 11, "used_region": 11, "region": 11, "elstat": 11, "electrostat": 11, "potenti": 11, "orbint": [11, 17], "orbit": 11, "pauli": 11, "repuls": 11, "popul": 11, "nuclear_intern": 11, "intern": [11, 15], "number_of_mod": 11, "3n": 11, "linear": 11, "number_of_imaginary_mod": 11, "sort": 11, "low": 11, "intens": 11, "nparrai": 11, "denisti": 11, "initi": 11, "inp_path": 11, "summari": 11, "human": 11, "readabl": 11, "xc": 11, "categori": 11, "gga": 11, "metahybrid": 11, "etc": 11, "empiricalsc": 11, "empir": 11, "mp2": 11, "scm": 11, "major": 11, "year": 11, "releas": 11, "minor": 11, "micro": 11, "revis": 11, "date": 11, "datetim": 11, "ams_vers": [11, 17], "job_id": 11, "might": 11, "uniqu": 11, "identifi": 11, "is_multijob": 11, "multijob": 11, "histori": 11, "cpu": 11, "spent": 11, "sy": 11, "io": 11, "creation": 11, "destruct": 11, "larger": 11, "than": [4, 11], "reader": 11, "succ": 11, "reason": 11, "kfreader": 11, "kffile": 11, "correctli": 11, "explain": 11, "success": 11, "unknown": 11, "w": 11, "u": [11, 16], "f": [11, 16], "els": 11, "number_of_atom": 11, "atom_numb": 11, "atom_mass": 11, "mass": 11, "frag_indic": 11, "number_of_entri": 11, "natur": 11, "scan": 11, "input_block": 11, "block": 11, "parentblock": 11, "subblock": 11, "subsubblock": 11, "nonstandard": 11, "subsubsubblock": 11, "within": 11, "special": [11, 16], "entri": 11, "inp": 11, "tini": 11, "take": [9, 11], "long": 11, "open": [11, 16], "especi": 11, "so": [11, 14], "better": 11, "onc": 11, "subclass": [11, 16], "track": 11, "figur": 11, "trim": 11, "reduc": 11, "files": 11, "tracker": 11, "storag": 11, "sinc": 11, "quit": [4, 11, 16], "larg": 11, "forget": [11, 16], "lest": 11, "memori": 11, "issu": [11, 16], "kf": 11, "claus": 11, "transitionstatesearch": 11, "usedqro": 11, "qro": 11, "wavefunct": 11, "used_qro": 11, "saddlepoint": 11, "n_imag": 11, "entropi": 11, "certain": 11, "hf": 11, "ccsd": 11, "_corr": 11, "correl": 11, "t1": 11, "diagnost": 11, "highest": 11, "valid": 11, "s2": 11, "oper": 11, "s2_expect": 11, "ideal": 11, "spin_contamin": 11, "contamin": 11, "observ": 11, "insensit": 11, "retain": 11, "overrid": 11, "hide": 11, "dunder": 11, "expos": 11, "view": 11, "multikei": 11, "join": 11, "gotten": 11, "basic": [9, 11], "done": [11, 17], "band": [11, 17], "typic": [11, 16], "easili": [11, 16, 17], "just": [11, 17], "_": 11, "fixtur": [11, 17], "ethanol": [11, 17], "2022": [11, 17], "103": [11, 17], "r104886": [11, 17], "06": [11, 17], "c": [11, 17], "2738": [11, 17], "644830445246": [11, 17], "1056": [11, 17], "9706925183411": [11, 17], "3795": [11, 17], "615522963587": [11, 17], "number_of_imag_mod": [11, 17], "_dict": 11, "doc": 11, "librari": [11, 14], "stdtype": 11, "master": 11, "mani": 14, "helper": 14, "theochem": 14, "overview": 14, "page": [14, 16], "heavi": [14, 16], "develop": [14, 16], "guarante": 14, "older": 14, "newer": 14, "small": 15, "help": 15, "offer": 16, "tool": 16, "effici": [4, 16], "comput": 16, "useful": 16, "lift": 16, "background": 16, "while": 16, "cleaner": 16, "proof": 16, "won": 16, "molecule_1": 16, "adf_calcul": 16, "featur": 16, "abl": 16, "instead": 16, "crest_job": 16, "conformer_xyz": 16, "enumer": 16, "opt_job": 16, "olyp": 16, "d3": 16, "bj": 16, "conformer_": 16, "regular": 16, "ensembl": 16, "sampl": 16, "quantum": 16, "growth": 16, "qcg": 16, "explicit": 16, "github": 16, "let": 16, "licens": 16, "execut": 16, "click": 16, "simpl": 16, "water": 16, "dimer": 16, "bp86": 16, "enter": 16, "appear": 16, "pretti": 16, "much": 16, "everyth": 16, "go_water_dim": 16, "download": 16, "water_dim": 16, "61075942": 16, "14972207": 16, "27324620": 16, "14984188": 16, "05173067": 16, "71502154": 16, "65160034": 16, "06225163": 16, "52042212": 16, "38869649": 16, "77034720": 16, "kind": 16, "littl": 16, "nh3bh3": 16, "fragment_nam": 16, "spell_check": 3, "naive_recurs": [3, 4], "wagner_fisch": [3, 4], "get_closest": [3, 4], "make_suggest": [3, 4], "caller_level": 4, "na\u00efv": 4, "recurs": 4, "levenshtein": 4, "slow": 4, "faster": 4, "altern": 4, "25x": 4, "substitution_cost": 4, "case_missmatch_cost": 4, "insertion_cost": 4, "wagner": 4, "fischer": 4, "penalti": 4, "incur": 4, "erron": 4, "substitut": 4, "miss": 4, "match": 4, "cost": 4, "insert": 4, "kitten": 4, "sit": 4, "slower": 4, "compare_func": 4, "ignore_cas": 4, "ignore_char": 4, "maximum_dist": 4, "similar": 4, "rest": 4, "collect": 4, "taken": [4, 9], "account": 4, "turn": 4, "lower": 4, "comparison": 4, "maximum": [4, 9], "greater": 4, "closest": 4, "mitten": 4, "bitten": 4, "close": 4, "2024": 4, "01": [4, 9], "35": 4, "find": 4, "did": 4, "postscript": [4, 9], "clean_workdir": [4, 9], "split_crest_xyz": [4, 9], "write_converged_geom": [4, 9], "irc": [4, 9], "add_postscript": [4, 9], "hess_fil": 9, "step_siz": 9, "min_path_length": 9, "max_point": 9, "300": 9, "intrins": 9, "hessian": 9, "constrain": 9, "a_0": 9, "da": 9, "switch": 9, "Be": 9, "preset": 9, "verybas": 9, "verygood": 9, "threshold": 9}, "objects": {"": [[4, 0, 0, "-", "tcutility"]], "tcutility": [[5, 0, 0, "-", "analysis"], [4, 0, 0, "-", "cache"], [4, 0, 0, "-", "constants"], [4, 4, 1, "", "ensure_2d"], [4, 4, 1, "", "ensure_list"], [4, 0, 0, "-", "formula"], [4, 0, 0, "-", "geometry"], [9, 0, 0, "-", "job"], [4, 0, 0, "-", "log"], [4, 0, 0, "-", "molecule"], [4, 0, 0, "-", "report"], [11, 0, 0, "-", "results"], [4, 0, 0, "-", "slurm"], [4, 0, 0, "-", "spell_check"], [4, 4, 1, "", "squeeze_list"], [12, 0, 0, "-", "typing"]], "tcutility.analysis": [[6, 0, 0, "-", "vdd"], [7, 0, 0, "-", "vibration"]], "tcutility.analysis.vdd": [[6, 0, 0, "-", "charge"], [6, 0, 0, "-", "manager"]], "tcutility.analysis.vdd.charge": [[6, 1, 1, "", "VDDCharge"]], "tcutility.analysis.vdd.charge.VDDCharge": [[6, 2, 1, "", "atom_index"], [6, 2, 1, "", "atom_symbol"], [6, 3, 1, "", "change_unit"], [6, 2, 1, "", "charge"], [6, 2, 1, "", "frag_index"]], "tcutility.analysis.vdd.manager": [[6, 1, 1, "", "VDDChargeManager"], [6, 4, 1, "", "change_unit_decorator"], [6, 4, 1, "", "create_vdd_charge_manager"]], "tcutility.analysis.vdd.manager.VDDChargeManager": [[6, 2, 1, "", "calc_dir"], [6, 3, 1, "", "change_unit"], [6, 3, 1, "", "charge_is_conserved"], [6, 3, 1, "", "get_summed_vdd_charges"], [6, 3, 1, "", "get_summed_vdd_charges_dataframe"], [6, 3, 1, "", "get_summed_vdd_charges_table"], [6, 3, 1, "", "get_vdd_charges"], [6, 3, 1, "", "get_vdd_charges_dataframe"], [6, 3, 1, "", "get_vdd_charges_table"], [6, 2, 1, "", "irreps"], [6, 2, 1, "", "is_fragment_calculation"], [6, 2, 1, "", "mol_charge"], [6, 2, 1, "", "name"], [6, 3, 1, "", "plot_vdd_charges_per_atom"], [6, 2, 1, "", "unit"], [6, 2, 1, "", "vdd_charges"], [6, 3, 1, "", "write_to_excel"], [6, 3, 1, "", "write_to_txt"]], "tcutility.analysis.vibration": [[7, 0, 0, "-", "ts_vibration"]], "tcutility.analysis.vibration.ts_vibration": [[7, 4, 1, "", "avg_relative_bond_length_delta"], [7, 4, 1, "", "determine_ts_reactioncoordinate"], [7, 4, 1, "", "validate_transitionstate"]], "tcutility.cache": [[4, 4, 1, "", "cache"], [4, 4, 1, "", "timed_cache"]], "tcutility.formula": [[4, 4, 1, "", "molecule"], [4, 4, 1, "", "parse_molecule"]], "tcutility.geometry": [[4, 1, 1, "", "KabschTransform"], [4, 4, 1, "", "RMSD"], [4, 1, 1, "", "Transform"], [4, 4, 1, "", "apply_rotmat"], [4, 4, 1, "", "get_rotmat"], [4, 4, 1, "", "random_points_in_anular_sphere"], [4, 4, 1, "", "random_points_on_sphere"], [4, 4, 1, "", "rotate"], [4, 4, 1, "", "vector_align_rotmat"]], "tcutility.geometry.Transform": [[4, 3, 1, "", "apply"], [4, 3, 1, "", "combine_transforms"], [4, 3, 1, "", "rotate"], [4, 3, 1, "", "scale"], [4, 3, 1, "", "translate"]], "tcutility.job": [[9, 0, 0, "-", "adf"], [9, 0, 0, "-", "ams"], [9, 0, 0, "-", "crest"], [9, 0, 0, "-", "dftb"], [9, 0, 0, "-", "generic"], [9, 0, 0, "-", "nmr"], [9, 0, 0, "-", "orca"], [10, 0, 0, "-", "postscripts"]], "tcutility.job.adf": [[9, 1, 1, "", "ADFFragmentJob"], [9, 1, 1, "", "ADFJob"]], "tcutility.job.adf.ADFFragmentJob": [[9, 3, 1, "", "add_fragment"], [9, 3, 1, "", "run"]], "tcutility.job.adf.ADFJob": [[9, 3, 1, "", "SCF_convergence"], [9, 3, 1, "", "basis_set"], [9, 3, 1, "", "functional"], [9, 3, 1, "", "multiplicity"], [9, 3, 1, "", "quality"], [9, 3, 1, "", "relativity"], [9, 3, 1, "", "solvent"], [9, 3, 1, "", "spin_polarization"], [9, 3, 1, "", "unrestricted"]], "tcutility.job.ams": [[9, 1, 1, "", "AMSJob"]], "tcutility.job.ams.AMSJob": [[9, 3, 1, "", "IRC"], [9, 3, 1, "", "charge"], [9, 3, 1, "", "geometry_convergence"], [9, 3, 1, "", "optimization"], [9, 5, 1, "", "output_mol_path"], [9, 3, 1, "", "single_point"], [9, 3, 1, "", "transition_state"], [9, 3, 1, "", "vibrations"]], "tcutility.job.crest": [[9, 1, 1, "", "CRESTJob"], [9, 1, 1, "", "QCGJob"]], "tcutility.job.crest.CRESTJob": [[9, 5, 1, "", "best_conformer_path"], [9, 3, 1, "", "charge"], [9, 5, 1, "", "conformer_directory"], [9, 3, 1, "", "get_conformer_xyz"], [9, 3, 1, "", "get_rotamer_xyz"], [9, 3, 1, "", "md_length"], [9, 3, 1, "", "md_temperature"], [9, 3, 1, "", "multiplicity"], [9, 5, 1, "", "rotamer_directory"], [9, 3, 1, "", "spin_polarization"]], "tcutility.job.crest.QCGJob": [[9, 3, 1, "", "alpb"], [9, 5, 1, "", "best_ensemble_path"], [9, 5, 1, "", "ensemble_directory"], [9, 3, 1, "", "ensemble_mode"], [9, 3, 1, "", "get_ensemble_xyz"], [9, 3, 1, "", "nofix"], [9, 3, 1, "", "nsolv"], [9, 3, 1, "", "solvent"]], "tcutility.job.dftb": [[9, 1, 1, "", "DFTBJob"]], "tcutility.job.dftb.DFTBJob": [[9, 3, 1, "", "kspace"], [9, 3, 1, "", "model"], [9, 3, 1, "", "solvent"]], "tcutility.job.generic": [[9, 1, 1, "", "Job"]], "tcutility.job.generic.Job": [[9, 3, 1, "", "add_postamble"], [9, 3, 1, "", "add_postscript"], [9, 3, 1, "", "add_preamble"], [9, 3, 1, "", "can_skip"], [9, 3, 1, "", "dependency"], [9, 5, 1, "", "inputfile_path"], [9, 3, 1, "", "molecule"], [9, 5, 1, "", "output_mol_path"], [9, 3, 1, "", "run"], [9, 5, 1, "", "runfile_path"], [9, 3, 1, "", "sbatch"], [9, 5, 1, "", "workdir"]], "tcutility.job.nmr": [[9, 1, 1, "", "NMRJob"]], "tcutility.job.nmr.NMRJob": [[9, 3, 1, "", "add_nics_point"]], "tcutility.job.orca": [[9, 1, 1, "", "ORCAJob"]], "tcutility.job.orca.ORCAJob": [[9, 3, 1, "", "charge"], [9, 3, 1, "", "get_input"], [9, 3, 1, "", "get_memory_usage"], [9, 3, 1, "", "multiplicity"], [9, 3, 1, "", "optimization"], [9, 3, 1, "", "single_point"], [9, 3, 1, "", "spin_polarization"], [9, 3, 1, "", "transition_state"], [9, 3, 1, "", "vibrations"]], "tcutility.job.postscripts": [[10, 0, 0, "-", "clean_workdir"], [10, 0, 0, "-", "split_crest_xyz"], [10, 0, 0, "-", "write_converged_geoms"]], "tcutility.log": [[4, 1, 1, "", "Emojis"], [4, 1, 1, "", "NoPrint"], [4, 4, 1, "", "boxed"], [4, 4, 1, "", "caller_name"], [4, 4, 1, "", "critical"], [4, 4, 1, "", "debug"], [4, 4, 1, "", "error"], [4, 4, 1, "", "flow"], [4, 4, 1, "", "info"], [4, 4, 1, "", "loadbar"], [4, 4, 1, "", "log"], [4, 4, 1, "", "table"], [4, 4, 1, "", "time_stamp"], [4, 4, 1, "", "warn"]], "tcutility.log.Emojis": [[4, 2, 1, "", "angstrom"], [4, 2, 1, "", "cancel"], [4, 2, 1, "", "empty"], [4, 2, 1, "", "fail"], [4, 2, 1, "", "finish"], [4, 2, 1, "", "good"], [4, 2, 1, "", "info"], [4, 2, 1, "", "larrow"], [4, 2, 1, "", "lrarrow"], [4, 2, 1, "", "question"], [4, 2, 1, "", "rarrow"], [4, 2, 1, "", "receive"], [4, 2, 1, "", "rlarrow"], [4, 2, 1, "", "send"], [4, 2, 1, "", "sleep"], [4, 2, 1, "", "wait"], [4, 2, 1, "", "warning"]], "tcutility.molecule": [[4, 4, 1, "", "guess_fragments"], [4, 4, 1, "", "load"], [4, 4, 1, "", "parse_str"], [4, 4, 1, "", "save"]], "tcutility.report": [[4, 1, 1, "", "SI"]], "tcutility.report.SI": [[4, 3, 1, "", "add_heading"], [4, 3, 1, "", "add_xyz"]], "tcutility.results": [[11, 0, 0, "-", "adf"], [11, 0, 0, "-", "ams"], [11, 0, 0, "-", "cache"], [11, 0, 0, "-", "dftb"], [11, 4, 1, "", "get_info"], [11, 0, 0, "-", "orca"], [11, 4, 1, "", "read"], [11, 0, 0, "-", "result"]], "tcutility.results.adf": [[11, 4, 1, "", "get_calc_settings"], [11, 4, 1, "", "get_level_of_theory"], [11, 4, 1, "", "get_properties"]], "tcutility.results.ams": [[11, 4, 1, "", "get_ams_info"], [11, 4, 1, "", "get_ams_input"], [11, 4, 1, "", "get_ams_version"], [11, 4, 1, "", "get_calc_files"], [11, 4, 1, "", "get_calculation_status"], [11, 4, 1, "", "get_history"], [11, 4, 1, "", "get_input_blocks"], [11, 4, 1, "", "get_molecules"], [11, 4, 1, "", "get_timing"]], "tcutility.results.cache": [[11, 1, 1, "", "TrackKFReader"], [11, 4, 1, "", "get"], [11, 4, 1, "", "store"], [11, 4, 1, "", "unload"]], "tcutility.results.cache.TrackKFReader": [[11, 3, 1, "", "read"]], "tcutility.results.dftb": [[11, 4, 1, "", "get_calc_settings"], [11, 4, 1, "", "get_properties"]], "tcutility.results.orca": [[11, 4, 1, "", "get_calc_files"], [11, 4, 1, "", "get_calc_settings"], [11, 4, 1, "", "get_calculation_status"], [11, 4, 1, "", "get_info"], [11, 4, 1, "", "get_input"], [11, 4, 1, "", "get_level_of_theory"], [11, 4, 1, "", "get_molecules"], [11, 4, 1, "", "get_properties"], [11, 4, 1, "", "get_version"], [11, 4, 1, "", "get_vibrations"]], "tcutility.results.result": [[11, 1, 1, "", "Result"]], "tcutility.results.result.Result": [[11, 3, 1, "", "as_plams_settings"], [11, 3, 1, "", "get_multi_key"], [11, 3, 1, "", "get_parent_tree"], [11, 3, 1, "", "items"], [11, 3, 1, "", "keys"], [11, 3, 1, "", "prune"]], "tcutility.slurm": [[4, 4, 1, "", "has_slurm"], [4, 4, 1, "", "sbatch"], [4, 4, 1, "", "squeue"], [4, 4, 1, "", "wait_for_job"], [4, 4, 1, "", "workdir_info"]], "tcutility.spell_check": [[4, 4, 1, "", "get_closest"], [4, 4, 1, "", "make_suggestion"], [4, 4, 1, "", "naive_recursive"], [4, 4, 1, "", "wagner_fischer"]], "tcutility.typing": [[12, 0, 0, "-", "arrays"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:function", "5": "py:property"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"], "5": ["py", "property", "Python property"]}, "titleterms": {"overview": [0, 16], "analysi": [0, 1, 2, 5, 6, 7], "modul": [0, 1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14], "transit": 1, "state": 1, "vdd": [2, 6], "charg": [2, 6], "requir": [2, 16], "exampl": [2, 13, 16], "api": [2, 14], "tcutil": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "packag": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15], "subpackag": [4, 5, 9], "submodul": [4, 6, 7, 9, 10, 11, 12], "cach": [4, 11], "constant": [4, 15], "formula": 4, "geometri": 4, "log": 4, "molecul": 4, "report": 4, "slurm": [4, 16], "content": [4, 5, 6, 7, 8, 9, 10, 11, 12], "manag": 6, "vibrat": 7, "ts_vibrat": 7, "atom_data_info": 8, "job": [9, 10, 13, 16], "adf": [9, 11], "am": [9, 11], "crest": 9, "dftb": [9, 11], "gener": 9, "nmr": 9, "orca": [9, 11], "result": [11, 13], "type": 12, "arrai": 12, "v0": 14, "7": [], "2": [], "document": 14, "extra": 14, "util": 14, "ar": 14, "full": 14, "indic": 14, "tabl": 14, "setup": 16, "workflow": 16, "class": 16, "support": 16, "depend": 16, "engin": 16, "read": 17, "calcul": 17, "8": 14, "0": [], "spell_check": 4, "1": [], "3": [], "4": [], "5": 14, "postscript": 10, "clean_workdir": 10, "split_crest_xyz": 10, "write_converged_geom": 10}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Overview of the analysis module": [[0, "overview-of-the-analysis-module"]], "Transition State Analysis module": [[1, "transition-state-analysis-module"]], "VDD Charge Analysis module": [[2, "vdd-charge-analysis-module"]], "Requirements": [[2, "requirements"], [16, "requirements"]], "Example": [[2, "example"]], "VDD analysis API": [[2, "vdd-analysis-api"]], "tcutility": [[3, "tcutility"]], "tcutility package": [[4, "tcutility-package"], [13, "tcutility-package"]], "Subpackages": [[4, "subpackages"], [5, "subpackages"], [9, "subpackages"]], "Submodules": [[4, "submodules"], [6, "submodules"], [7, "submodules"], [9, "submodules"], [10, "submodules"], [11, "submodules"], [12, "submodules"]], "tcutility.cache module": [[4, "module-tcutility.cache"]], "tcutility.constants module": [[4, "module-tcutility.constants"]], "tcutility.formula module": [[4, "module-tcutility.formula"]], "tcutility.geometry module": [[4, "module-tcutility.geometry"]], "tcutility.log module": [[4, "module-tcutility.log"]], "tcutility.molecule module": [[4, "module-tcutility.molecule"]], "tcutility.report module": [[4, "module-tcutility.report"]], "tcutility.slurm module": [[4, "module-tcutility.slurm"]], "tcutility.spell_check module": [[4, "module-tcutility.spell_check"]], "Module contents": [[4, "module-tcutility"], [5, "module-tcutility.analysis"], [6, "module-tcutility.analysis.vdd"], [7, "module-tcutility.analysis.vibration"], [8, "module-contents"], [9, "module-tcutility.job"], [10, "module-tcutility.job.postscripts"], [11, "module-tcutility.results"], [12, "module-tcutility.typing"]], "tcutility.analysis package": [[5, "tcutility-analysis-package"]], "tcutility.analysis.vdd package": [[6, "tcutility-analysis-vdd-package"]], "tcutility.analysis.vdd.charge module": [[6, "module-tcutility.analysis.vdd.charge"]], "tcutility.analysis.vdd.manager module": [[6, "module-tcutility.analysis.vdd.manager"]], "tcutility.analysis.vibration package": [[7, "tcutility-analysis-vibration-package"]], "tcutility.analysis.vibration.ts_vibration module": [[7, "module-tcutility.analysis.vibration.ts_vibration"]], "tcutility.atom_data_info package": [[8, "tcutility-atom-data-info-package"]], "tcutility.job package": [[9, "tcutility-job-package"], [13, "tcutility-job-package"]], "tcutility.job.adf module": [[9, "module-tcutility.job.adf"]], "tcutility.job.ams module": [[9, "module-tcutility.job.ams"]], "tcutility.job.crest module": [[9, "module-tcutility.job.crest"]], "tcutility.job.dftb module": [[9, "module-tcutility.job.dftb"]], "tcutility.job.generic module": [[9, "module-tcutility.job.generic"]], "tcutility.job.nmr module": [[9, "module-tcutility.job.nmr"]], "tcutility.job.orca module": [[9, "module-tcutility.job.orca"]], "tcutility.job.postscripts package": [[10, "tcutility-job-postscripts-package"]], "tcutility.job.postscripts.clean_workdir module": [[10, "module-tcutility.job.postscripts.clean_workdir"]], "tcutility.job.postscripts.split_crest_xyz module": [[10, "module-tcutility.job.postscripts.split_crest_xyz"]], "tcutility.job.postscripts.write_converged_geoms module": [[10, "module-tcutility.job.postscripts.write_converged_geoms"]], "tcutility.results package": [[11, "tcutility-results-package"], [13, "tcutility-results-package"]], "tcutility.results.adf module": [[11, "module-tcutility.results.adf"]], "tcutility.results.ams module": [[11, "module-tcutility.results.ams"]], "tcutility.results.cache module": [[11, "module-tcutility.results.cache"]], "tcutility.results.dftb module": [[11, "module-tcutility.results.dftb"]], "tcutility.results.orca module": [[11, "module-tcutility.results.orca"]], "tcutility.results.result module": [[11, "module-tcutility.results.result"]], "tcutility.typing package": [[12, "tcutility-typing-package"]], "tcutility.typing.arrays module": [[12, "module-tcutility.typing.arrays"]], "Examples": [[13, "examples"], [16, "examples"]], "TCutility v0.8.5 documentation": [[14, "tcutility-projectversion-documentation"]], "Extra (utility) modules are:": [[14, null]], "Full API:": [[14, null]], "Indices and tables": [[14, "indices-and-tables"]], "tcutility.constants package": [[15, "tcutility-constants-package"]], "Setup workflows with tcutility.job": [[16, "setup-workflows-with-tcutility-job"]], "Overview": [[16, "overview"]], "Job classes": [[16, "job-classes"]], "Slurm support": [[16, "slurm-support"]], "Job dependencies": [[16, "job-dependencies"]], "Supported engines": [[16, "supported-engines"]], "Reading a calculation": [[17, "reading-a-calculation"]]}, "indexentries": {"emojis (class in tcutility.log)": [[4, "tcutility.log.Emojis"]], "kabschtransform (class in tcutility.geometry)": [[4, "tcutility.geometry.KabschTransform"]], "noprint (class in tcutility.log)": [[4, "tcutility.log.NoPrint"]], "rmsd() (in module tcutility.geometry)": [[4, "tcutility.geometry.RMSD"]], "si (class in tcutility.report)": [[4, "tcutility.report.SI"]], "transform (class in tcutility.geometry)": [[4, "tcutility.geometry.Transform"]], "add_heading() (si method)": [[4, "tcutility.report.SI.add_heading"]], "add_xyz() (si method)": [[4, "tcutility.report.SI.add_xyz"]], "angstrom (emojis attribute)": [[4, "tcutility.log.Emojis.angstrom"]], "apply() (transform method)": [[4, "tcutility.geometry.Transform.apply"]], "apply_rotmat() (in module tcutility.geometry)": [[4, "tcutility.geometry.apply_rotmat"]], "boxed() (in module tcutility.log)": [[4, "tcutility.log.boxed"]], "cache() (in module tcutility.cache)": [[4, "tcutility.cache.cache"]], "caller_name() (in module tcutility.log)": [[4, "tcutility.log.caller_name"]], "cancel (emojis attribute)": [[4, "tcutility.log.Emojis.cancel"]], "combine_transforms() (transform method)": [[4, "tcutility.geometry.Transform.combine_transforms"]], "critical() (in module tcutility.log)": [[4, "tcutility.log.critical"]], "debug() (in module tcutility.log)": [[4, "tcutility.log.debug"]], "empty (emojis attribute)": [[4, "tcutility.log.Emojis.empty"]], "ensure_2d() (in module tcutility)": [[4, "tcutility.ensure_2d"]], "ensure_list() (in module tcutility)": [[4, "tcutility.ensure_list"]], "error() (in module tcutility.log)": [[4, "tcutility.log.error"]], "fail (emojis attribute)": [[4, "tcutility.log.Emojis.fail"]], "finish (emojis attribute)": [[4, "tcutility.log.Emojis.finish"]], "flow() (in module tcutility.log)": [[4, "tcutility.log.flow"]], "get_closest() (in module tcutility.spell_check)": [[4, "tcutility.spell_check.get_closest"]], "get_rotmat() (in module tcutility.geometry)": [[4, "tcutility.geometry.get_rotmat"]], "good (emojis attribute)": [[4, "tcutility.log.Emojis.good"]], "guess_fragments() (in module tcutility.molecule)": [[4, "tcutility.molecule.guess_fragments"]], "has_slurm() (in module tcutility.slurm)": [[4, "tcutility.slurm.has_slurm"]], "info (emojis attribute)": [[4, "tcutility.log.Emojis.info"]], "info() (in module tcutility.log)": [[4, "tcutility.log.info"]], "larrow (emojis attribute)": [[4, "tcutility.log.Emojis.larrow"]], "load() (in module tcutility.molecule)": [[4, "tcutility.molecule.load"]], "loadbar() (in module tcutility.log)": [[4, "tcutility.log.loadbar"]], "log() (in module tcutility.log)": [[4, "tcutility.log.log"]], "lrarrow (emojis attribute)": [[4, "tcutility.log.Emojis.lrarrow"]], "make_suggestion() (in module tcutility.spell_check)": [[4, "tcutility.spell_check.make_suggestion"]], "module": [[4, "module-tcutility"], [4, "module-tcutility.cache"], [4, "module-tcutility.constants"], [4, "module-tcutility.formula"], [4, "module-tcutility.geometry"], [4, "module-tcutility.log"], [4, "module-tcutility.molecule"], [4, "module-tcutility.report"], [4, "module-tcutility.slurm"], [4, "module-tcutility.spell_check"], [5, "module-tcutility.analysis"], [6, "module-tcutility.analysis.vdd"], [6, "module-tcutility.analysis.vdd.charge"], [6, "module-tcutility.analysis.vdd.manager"], [7, "module-tcutility.analysis.vibration"], [7, "module-tcutility.analysis.vibration.ts_vibration"], [9, "module-tcutility.job"], [9, "module-tcutility.job.adf"], [9, "module-tcutility.job.ams"], [9, "module-tcutility.job.crest"], [9, "module-tcutility.job.dftb"], [9, "module-tcutility.job.generic"], [9, "module-tcutility.job.nmr"], [9, "module-tcutility.job.orca"], [10, "module-tcutility.job.postscripts"], [10, "module-tcutility.job.postscripts.clean_workdir"], [10, "module-tcutility.job.postscripts.split_crest_xyz"], [10, "module-tcutility.job.postscripts.write_converged_geoms"], [11, "module-tcutility.results"], [11, "module-tcutility.results.adf"], [11, "module-tcutility.results.ams"], [11, "module-tcutility.results.cache"], [11, "module-tcutility.results.dftb"], [11, "module-tcutility.results.orca"], [11, "module-tcutility.results.result"], [12, "module-tcutility.typing"], [12, "module-tcutility.typing.arrays"]], "molecule() (in module tcutility.formula)": [[4, "tcutility.formula.molecule"]], "naive_recursive() (in module tcutility.spell_check)": [[4, "tcutility.spell_check.naive_recursive"]], "parse_molecule() (in module tcutility.formula)": [[4, "tcutility.formula.parse_molecule"]], "parse_str() (in module tcutility.molecule)": [[4, "tcutility.molecule.parse_str"]], "question (emojis attribute)": [[4, "tcutility.log.Emojis.question"]], "random_points_in_anular_sphere() (in module tcutility.geometry)": [[4, "tcutility.geometry.random_points_in_anular_sphere"]], "random_points_on_sphere() (in module tcutility.geometry)": [[4, "tcutility.geometry.random_points_on_sphere"]], "rarrow (emojis attribute)": [[4, "tcutility.log.Emojis.rarrow"]], "receive (emojis attribute)": [[4, "tcutility.log.Emojis.receive"]], "rlarrow (emojis attribute)": [[4, "tcutility.log.Emojis.rlarrow"]], "rotate() (transform method)": [[4, "tcutility.geometry.Transform.rotate"]], "rotate() (in module tcutility.geometry)": [[4, "tcutility.geometry.rotate"]], "save() (in module tcutility.molecule)": [[4, "tcutility.molecule.save"]], "sbatch() (in module tcutility.slurm)": [[4, "tcutility.slurm.sbatch"]], "scale() (transform method)": [[4, "tcutility.geometry.Transform.scale"]], "send (emojis attribute)": [[4, "tcutility.log.Emojis.send"]], "sleep (emojis attribute)": [[4, "tcutility.log.Emojis.sleep"]], "squeeze_list() (in module tcutility)": [[4, "tcutility.squeeze_list"]], "squeue() (in module tcutility.slurm)": [[4, "tcutility.slurm.squeue"]], "table() (in module tcutility.log)": [[4, "tcutility.log.table"]], "tcutility": [[4, "module-tcutility"]], "tcutility.cache": [[4, "module-tcutility.cache"]], "tcutility.constants": [[4, "module-tcutility.constants"]], "tcutility.formula": [[4, "module-tcutility.formula"]], "tcutility.geometry": [[4, "module-tcutility.geometry"]], "tcutility.log": [[4, "module-tcutility.log"]], "tcutility.molecule": [[4, "module-tcutility.molecule"]], "tcutility.report": [[4, "module-tcutility.report"]], "tcutility.slurm": [[4, "module-tcutility.slurm"]], "tcutility.spell_check": [[4, "module-tcutility.spell_check"]], "time_stamp() (in module tcutility.log)": [[4, "tcutility.log.time_stamp"]], "timed_cache() (in module tcutility.cache)": [[4, "tcutility.cache.timed_cache"]], "translate() (transform method)": [[4, "tcutility.geometry.Transform.translate"]], "vector_align_rotmat() (in module tcutility.geometry)": [[4, "tcutility.geometry.vector_align_rotmat"]], "wagner_fischer() (in module tcutility.spell_check)": [[4, "tcutility.spell_check.wagner_fischer"]], "wait (emojis attribute)": [[4, "tcutility.log.Emojis.wait"]], "wait_for_job() (in module tcutility.slurm)": [[4, "tcutility.slurm.wait_for_job"]], "warn() (in module tcutility.log)": [[4, "tcutility.log.warn"]], "warning (emojis attribute)": [[4, "tcutility.log.Emojis.warning"]], "workdir_info() (in module tcutility.slurm)": [[4, "tcutility.slurm.workdir_info"]], "tcutility.analysis": [[5, "module-tcutility.analysis"]], "vddcharge (class in tcutility.analysis.vdd.charge)": [[6, "tcutility.analysis.vdd.charge.VDDCharge"]], "vddchargemanager (class in tcutility.analysis.vdd.manager)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager"]], "atom_index (vddcharge attribute)": [[6, "tcutility.analysis.vdd.charge.VDDCharge.atom_index"]], "atom_symbol (vddcharge attribute)": [[6, "tcutility.analysis.vdd.charge.VDDCharge.atom_symbol"]], "calc_dir (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.calc_dir"]], "change_unit() (vddcharge method)": [[6, "tcutility.analysis.vdd.charge.VDDCharge.change_unit"]], "change_unit() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.change_unit"]], "change_unit_decorator() (in module tcutility.analysis.vdd.manager)": [[6, "tcutility.analysis.vdd.manager.change_unit_decorator"]], "charge (vddcharge attribute)": [[6, "tcutility.analysis.vdd.charge.VDDCharge.charge"]], "charge_is_conserved() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.charge_is_conserved"]], "create_vdd_charge_manager() (in module tcutility.analysis.vdd.manager)": [[6, "tcutility.analysis.vdd.manager.create_vdd_charge_manager"]], "frag_index (vddcharge attribute)": [[6, "tcutility.analysis.vdd.charge.VDDCharge.frag_index"]], "get_summed_vdd_charges() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_summed_vdd_charges"]], "get_summed_vdd_charges_dataframe() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_summed_vdd_charges_dataframe"]], "get_summed_vdd_charges_table() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_summed_vdd_charges_table"]], "get_vdd_charges() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_vdd_charges"]], "get_vdd_charges_dataframe() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_vdd_charges_dataframe"]], "get_vdd_charges_table() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_vdd_charges_table"]], "irreps (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.irreps"]], "is_fragment_calculation (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.is_fragment_calculation"]], "mol_charge (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.mol_charge"]], "name (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.name"]], "plot_vdd_charges_per_atom() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.plot_vdd_charges_per_atom"]], "tcutility.analysis.vdd": [[6, "module-tcutility.analysis.vdd"]], "tcutility.analysis.vdd.charge": [[6, "module-tcutility.analysis.vdd.charge"]], "tcutility.analysis.vdd.manager": [[6, "module-tcutility.analysis.vdd.manager"]], "unit (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.unit"]], "vdd_charges (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.vdd_charges"]], "write_to_excel() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.write_to_excel"]], "write_to_txt() (vddchargemanager static method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.write_to_txt"]], "avg_relative_bond_length_delta() (in module tcutility.analysis.vibration.ts_vibration)": [[7, "tcutility.analysis.vibration.ts_vibration.avg_relative_bond_length_delta"]], "determine_ts_reactioncoordinate() (in module tcutility.analysis.vibration.ts_vibration)": [[7, "tcutility.analysis.vibration.ts_vibration.determine_ts_reactioncoordinate"]], "tcutility.analysis.vibration": [[7, "module-tcutility.analysis.vibration"]], "tcutility.analysis.vibration.ts_vibration": [[7, "module-tcutility.analysis.vibration.ts_vibration"]], "validate_transitionstate() (in module tcutility.analysis.vibration.ts_vibration)": [[7, "tcutility.analysis.vibration.ts_vibration.validate_transitionstate"]], "adffragmentjob (class in tcutility.job.adf)": [[9, "tcutility.job.adf.ADFFragmentJob"]], "adfjob (class in tcutility.job.adf)": [[9, "tcutility.job.adf.ADFJob"]], "amsjob (class in tcutility.job.ams)": [[9, "tcutility.job.ams.AMSJob"]], "crestjob (class in tcutility.job.crest)": [[9, "tcutility.job.crest.CRESTJob"]], "dftbjob (class in tcutility.job.dftb)": [[9, "tcutility.job.dftb.DFTBJob"]], "irc() (amsjob method)": [[9, "tcutility.job.ams.AMSJob.IRC"]], "job (class in tcutility.job.generic)": [[9, "tcutility.job.generic.Job"]], "nmrjob (class in tcutility.job.nmr)": [[9, "tcutility.job.nmr.NMRJob"]], "orcajob (class in tcutility.job.orca)": [[9, "tcutility.job.orca.ORCAJob"]], "qcgjob (class in tcutility.job.crest)": [[9, "tcutility.job.crest.QCGJob"]], "scf_convergence() (adfjob method)": [[9, "tcutility.job.adf.ADFJob.SCF_convergence"]], "add_fragment() (adffragmentjob method)": [[9, "tcutility.job.adf.ADFFragmentJob.add_fragment"]], "add_nics_point() (nmrjob method)": [[9, "tcutility.job.nmr.NMRJob.add_nics_point"]], "add_postamble() (job method)": [[9, "tcutility.job.generic.Job.add_postamble"]], "add_postscript() (job method)": [[9, "tcutility.job.generic.Job.add_postscript"]], "add_preamble() (job method)": [[9, "tcutility.job.generic.Job.add_preamble"]], "alpb() (qcgjob method)": [[9, "tcutility.job.crest.QCGJob.alpb"]], "basis_set() (adfjob method)": [[9, "tcutility.job.adf.ADFJob.basis_set"]], "best_conformer_path (crestjob property)": [[9, "tcutility.job.crest.CRESTJob.best_conformer_path"]], "best_ensemble_path (qcgjob property)": [[9, "tcutility.job.crest.QCGJob.best_ensemble_path"]], "can_skip() (job method)": [[9, "tcutility.job.generic.Job.can_skip"]], "charge() (amsjob method)": [[9, "tcutility.job.ams.AMSJob.charge"]], "charge() (crestjob method)": [[9, "tcutility.job.crest.CRESTJob.charge"]], "charge() (orcajob method)": [[9, "tcutility.job.orca.ORCAJob.charge"]], "conformer_directory (crestjob property)": [[9, "tcutility.job.crest.CRESTJob.conformer_directory"]], "dependency() (job method)": [[9, "tcutility.job.generic.Job.dependency"]], "ensemble_directory (qcgjob property)": [[9, "tcutility.job.crest.QCGJob.ensemble_directory"]], "ensemble_mode() (qcgjob method)": [[9, "tcutility.job.crest.QCGJob.ensemble_mode"]], "functional() (adfjob method)": [[9, "tcutility.job.adf.ADFJob.functional"]], "geometry_convergence() (amsjob method)": [[9, "tcutility.job.ams.AMSJob.geometry_convergence"]], "get_conformer_xyz() (crestjob method)": [[9, "tcutility.job.crest.CRESTJob.get_conformer_xyz"]], "get_ensemble_xyz() (qcgjob method)": [[9, "tcutility.job.crest.QCGJob.get_ensemble_xyz"]], "get_input() (orcajob method)": [[9, "tcutility.job.orca.ORCAJob.get_input"]], "get_memory_usage() (orcajob method)": [[9, "tcutility.job.orca.ORCAJob.get_memory_usage"]], "get_rotamer_xyz() (crestjob method)": [[9, "tcutility.job.crest.CRESTJob.get_rotamer_xyz"]], "inputfile_path (job property)": [[9, "tcutility.job.generic.Job.inputfile_path"]], "kspace() (dftbjob method)": [[9, "tcutility.job.dftb.DFTBJob.kspace"]], "md_length() (crestjob method)": [[9, "tcutility.job.crest.CRESTJob.md_length"]], "md_temperature() (crestjob method)": [[9, "tcutility.job.crest.CRESTJob.md_temperature"]], "model() (dftbjob method)": [[9, "tcutility.job.dftb.DFTBJob.model"]], "molecule() (job method)": [[9, "tcutility.job.generic.Job.molecule"]], "multiplicity() (adfjob method)": [[9, "tcutility.job.adf.ADFJob.multiplicity"]], "multiplicity() (crestjob method)": [[9, "tcutility.job.crest.CRESTJob.multiplicity"]], "multiplicity() (orcajob method)": [[9, "tcutility.job.orca.ORCAJob.multiplicity"]], "nofix() (qcgjob method)": [[9, "tcutility.job.crest.QCGJob.nofix"]], "nsolv() (qcgjob method)": [[9, "tcutility.job.crest.QCGJob.nsolv"]], "optimization() (amsjob method)": [[9, "tcutility.job.ams.AMSJob.optimization"]], "optimization() (orcajob method)": [[9, "tcutility.job.orca.ORCAJob.optimization"]], "output_mol_path (amsjob property)": [[9, "tcutility.job.ams.AMSJob.output_mol_path"]], "output_mol_path (job property)": [[9, "tcutility.job.generic.Job.output_mol_path"]], "quality() (adfjob method)": [[9, "tcutility.job.adf.ADFJob.quality"]], "relativity() (adfjob method)": [[9, "tcutility.job.adf.ADFJob.relativity"]], "rotamer_directory (crestjob property)": [[9, "tcutility.job.crest.CRESTJob.rotamer_directory"]], "run() (adffragmentjob method)": [[9, "tcutility.job.adf.ADFFragmentJob.run"]], "run() (job method)": [[9, "tcutility.job.generic.Job.run"]], "runfile_path (job property)": [[9, "tcutility.job.generic.Job.runfile_path"]], "sbatch() (job method)": [[9, "tcutility.job.generic.Job.sbatch"]], "single_point() (amsjob method)": [[9, "tcutility.job.ams.AMSJob.single_point"]], "single_point() (orcajob method)": [[9, "tcutility.job.orca.ORCAJob.single_point"]], "solvent() (adfjob method)": [[9, "tcutility.job.adf.ADFJob.solvent"]], "solvent() (dftbjob method)": [[9, "tcutility.job.dftb.DFTBJob.solvent"]], "solvent() (qcgjob method)": [[9, "tcutility.job.crest.QCGJob.solvent"]], "spin_polarization() (adfjob method)": [[9, "tcutility.job.adf.ADFJob.spin_polarization"]], "spin_polarization() (crestjob method)": [[9, "tcutility.job.crest.CRESTJob.spin_polarization"]], "spin_polarization() (orcajob method)": [[9, "tcutility.job.orca.ORCAJob.spin_polarization"]], "tcutility.job": [[9, "module-tcutility.job"]], "tcutility.job.adf": [[9, "module-tcutility.job.adf"]], "tcutility.job.ams": [[9, "module-tcutility.job.ams"]], "tcutility.job.crest": [[9, "module-tcutility.job.crest"]], "tcutility.job.dftb": [[9, "module-tcutility.job.dftb"]], "tcutility.job.generic": [[9, "module-tcutility.job.generic"]], "tcutility.job.nmr": [[9, "module-tcutility.job.nmr"]], "tcutility.job.orca": [[9, "module-tcutility.job.orca"]], "transition_state() (amsjob method)": [[9, "tcutility.job.ams.AMSJob.transition_state"]], "transition_state() (orcajob method)": [[9, "tcutility.job.orca.ORCAJob.transition_state"]], "unrestricted() (adfjob method)": [[9, "tcutility.job.adf.ADFJob.unrestricted"]], "vibrations() (amsjob method)": [[9, "tcutility.job.ams.AMSJob.vibrations"]], "vibrations() (orcajob method)": [[9, "tcutility.job.orca.ORCAJob.vibrations"]], "workdir (job property)": [[9, "tcutility.job.generic.Job.workdir"]], "tcutility.job.postscripts": [[10, "module-tcutility.job.postscripts"]], "tcutility.job.postscripts.clean_workdir": [[10, "module-tcutility.job.postscripts.clean_workdir"]], "tcutility.job.postscripts.split_crest_xyz": [[10, "module-tcutility.job.postscripts.split_crest_xyz"]], "tcutility.job.postscripts.write_converged_geoms": [[10, "module-tcutility.job.postscripts.write_converged_geoms"]], "result (class in tcutility.results.result)": [[11, "tcutility.results.result.Result"]], "trackkfreader (class in tcutility.results.cache)": [[11, "tcutility.results.cache.TrackKFReader"]], "as_plams_settings() (result method)": [[11, "tcutility.results.result.Result.as_plams_settings"]], "get() (in module tcutility.results.cache)": [[11, "tcutility.results.cache.get"]], "get_ams_info() (in module tcutility.results.ams)": [[11, "tcutility.results.ams.get_ams_info"]], "get_ams_input() (in module tcutility.results.ams)": [[11, "tcutility.results.ams.get_ams_input"]], "get_ams_version() (in module tcutility.results.ams)": [[11, "tcutility.results.ams.get_ams_version"]], "get_calc_files() (in module tcutility.results.ams)": [[11, "tcutility.results.ams.get_calc_files"]], "get_calc_files() (in module tcutility.results.orca)": [[11, "tcutility.results.orca.get_calc_files"]], "get_calc_settings() (in module tcutility.results.adf)": [[11, "tcutility.results.adf.get_calc_settings"]], "get_calc_settings() (in module tcutility.results.dftb)": [[11, "tcutility.results.dftb.get_calc_settings"]], "get_calc_settings() (in module tcutility.results.orca)": [[11, "tcutility.results.orca.get_calc_settings"]], "get_calculation_status() (in module tcutility.results.ams)": [[11, "tcutility.results.ams.get_calculation_status"]], "get_calculation_status() (in module tcutility.results.orca)": [[11, "tcutility.results.orca.get_calculation_status"]], "get_history() (in module tcutility.results.ams)": [[11, "tcutility.results.ams.get_history"]], "get_info() (in module tcutility.results)": [[11, "tcutility.results.get_info"]], "get_info() (in module tcutility.results.orca)": [[11, "tcutility.results.orca.get_info"]], "get_input() (in module tcutility.results.orca)": [[11, "tcutility.results.orca.get_input"]], "get_input_blocks() (in module tcutility.results.ams)": [[11, "tcutility.results.ams.get_input_blocks"]], "get_level_of_theory() (in module tcutility.results.adf)": [[11, "tcutility.results.adf.get_level_of_theory"]], "get_level_of_theory() (in module tcutility.results.orca)": [[11, "tcutility.results.orca.get_level_of_theory"]], "get_molecules() (in module tcutility.results.ams)": [[11, "tcutility.results.ams.get_molecules"]], "get_molecules() (in module tcutility.results.orca)": [[11, "tcutility.results.orca.get_molecules"]], "get_multi_key() (result method)": [[11, "tcutility.results.result.Result.get_multi_key"]], "get_parent_tree() (result method)": [[11, "tcutility.results.result.Result.get_parent_tree"]], "get_properties() (in module tcutility.results.adf)": [[11, "tcutility.results.adf.get_properties"]], "get_properties() (in module tcutility.results.dftb)": [[11, "tcutility.results.dftb.get_properties"]], "get_properties() (in module tcutility.results.orca)": [[11, "tcutility.results.orca.get_properties"]], "get_timing() (in module tcutility.results.ams)": [[11, "tcutility.results.ams.get_timing"]], "get_version() (in module tcutility.results.orca)": [[11, "tcutility.results.orca.get_version"]], "get_vibrations() (in module tcutility.results.orca)": [[11, "tcutility.results.orca.get_vibrations"]], "items() (result method)": [[11, "tcutility.results.result.Result.items"]], "keys() (result method)": [[11, "tcutility.results.result.Result.keys"]], "prune() (result method)": [[11, "tcutility.results.result.Result.prune"]], "read() (trackkfreader method)": [[11, "tcutility.results.cache.TrackKFReader.read"]], "read() (in module tcutility.results)": [[11, "tcutility.results.read"]], "store() (in module tcutility.results.cache)": [[11, "tcutility.results.cache.store"]], "tcutility.results": [[11, "module-tcutility.results"]], "tcutility.results.adf": [[11, "module-tcutility.results.adf"]], "tcutility.results.ams": [[11, "module-tcutility.results.ams"]], "tcutility.results.cache": [[11, "module-tcutility.results.cache"]], "tcutility.results.dftb": [[11, "module-tcutility.results.dftb"]], "tcutility.results.orca": [[11, "module-tcutility.results.orca"]], "tcutility.results.result": [[11, "module-tcutility.results.result"]], "unload() (in module tcutility.results.cache)": [[11, "tcutility.results.cache.unload"]], "tcutility.typing": [[12, "module-tcutility.typing"]], "tcutility.typing.arrays": [[12, "module-tcutility.typing.arrays"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["analysis/analysis", "analysis/transition_state_analysis", "analysis/vdd_charge_analysis", "api/modules", "api/tcutility", "api/tcutility.analysis", "api/tcutility.analysis.vdd", "api/tcutility.analysis.vibration", "api/tcutility.atom_data_info", "api/tcutility.data", "api/tcutility.data.atom_data_info", "api/tcutility.job", "api/tcutility.job.postscripts", "api/tcutility.results", "api/tcutility.typing", "examples", "index", "tcutility.constants", "tcutility.job", "tcutility.results"], "filenames": ["analysis/analysis.rst", "analysis/transition_state_analysis.rst", "analysis/vdd_charge_analysis.rst", "api/modules.rst", "api/tcutility.rst", "api/tcutility.analysis.rst", "api/tcutility.analysis.vdd.rst", "api/tcutility.analysis.vibration.rst", "api/tcutility.atom_data_info.rst", "api/tcutility.data.rst", "api/tcutility.data.atom_data_info.rst", "api/tcutility.job.rst", "api/tcutility.job.postscripts.rst", "api/tcutility.results.rst", "api/tcutility.typing.rst", "examples.rst", "index.rst", "tcutility.constants.rst", "tcutility.job.rst", "tcutility.results.rst"], "titles": ["Overview of the analysis module", "Transition State Analysis module", "VDD Charge Analysis module", "tcutility", "tcutility package", "tcutility.analysis package", "tcutility.analysis.vdd package", "tcutility.analysis.vibration package", "tcutility.atom_data_info package", "tcutility.data package", "tcutility.data.atom_data_info package", "tcutility.job package", "tcutility.job.postscripts package", "tcutility.results package", "tcutility.typing package", "Examples", "TCutility v0.8.5 documentation", "tcutility.constants package", "Setup workflows with tcutility.job", "Reading a calculation"], "terms": {"thi": [0, 1, 2, 4, 7, 9, 11, 13, 16, 18, 19], "chapter": 0, "contain": [0, 1, 2, 4, 7, 9, 11, 13, 16, 17], "descript": [0, 4], "all": [0, 4, 7, 9, 11, 18], "function": [0, 2, 3, 4, 7, 11, 13, 16, 18, 19], "includ": [0, 2, 4, 9, 13, 18, 19], "exampl": [0, 1, 4, 9, 11, 13], "usag": [0, 4, 13, 18, 19], "below": [0, 4, 13, 18, 19], "i": [0, 1, 2, 4, 6, 7, 9, 11, 13, 16, 18, 19], "list": [0, 2, 4, 6, 7, 11, 13], "avail": [0, 4, 6, 9, 11, 18], "transit": [0, 7, 11, 16], "state": [0, 7, 11, 16], "vdd": [0, 1, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "charg": [0, 1, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "requir": 0, "api": [0, 18], "tcutil": [0, 1, 2, 19], "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 16, 17, 18, 19], "read": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "manag": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "vddchargemanag": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "vddcharg": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "change_unit": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "v0": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17, 18, 19], "7": 2, "2": [2, 4, 11, 13, 18], "text": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "cm": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "1": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "kcal": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "mol": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "km": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "code": [1, 4, 13, 16, 18], "document": [1, 4, 11, 18], "still": [1, 4, 11], "under": [1, 16], "construct": [1, 11], "when": [2, 4, 9, 11, 13, 18], "calcul": [2, 4, 7, 11, 13, 16, 18], "perform": [2, 13], "ha": [2, 4, 7, 11, 13], "succesfulli": [2, 11], "finish": [2, 3, 4, 11, 13, 18], "can": [2, 4, 6, 9, 11, 13, 18, 19], "us": [2, 4, 6, 7, 9, 11, 13, 16, 17, 18, 19], "extract": 2, "voronoi": [2, 13], "deform": [2, 13], "densiti": [2, 11, 18], "The": [2, 4, 6, 9, 11, 13, 18, 19], "measur": 2, "flow": [2, 3, 4], "between": [2, 4, 7, 11, 13, 18], "atom": [2, 3, 4, 7, 11, 13, 18], "offici": 2, "cell": 2, "from": [2, 4, 6, 7, 9, 11, 13, 18, 19], "non": [2, 13], "interact": [2, 13], "promolecul": 2, "feel": 2, "environ": 2, "other": [2, 4, 11], "molecular": [2, 4, 11, 13], "enviro": 2, "If": [2, 4, 7, 11, 13, 18], "symmetri": [2, 7, 13, 19], "decompos": [2, 13], "contribut": [2, 13], "seper": 2, "irreduc": 2, "represent": [2, 4], "A": [2, 4, 9, 11, 17, 18], "adf": [2, 3, 4, 9, 18, 19], "engin": [2, 13, 19], "locat": [2, 13], "directori": [2, 4, 11, 13, 18], "am": [2, 3, 4, 7, 18, 19], "rkf": [2, 7, 11, 13], "file": [2, 4, 6, 7, 9, 11, 13, 18], "first": [2, 4, 7, 11, 13, 18], "relev": [2, 13], "need": [2, 11, 18], "load": [2, 3, 4, 11, 18], "These": [2, 4, 13], "pathlib": 2, "handl": [2, 4, 11, 13, 18], "path": [2, 4, 6, 7, 9, 11, 13, 18], "In": [2, 4, 11, 13, 18], "addit": [2, 11], "which": [2, 4, 11, 13, 18], "interfac": 2, "analys": [2, 4, 13], "For": [2, 4, 11, 13, 18], "we": [2, 4, 11, 13, 18], "found": [2, 7, 11], "test": [2, 11, 13, 19], "packag": [2, 3, 16, 18, 19], "assum": [2, 4], "you": [2, 4, 9, 11, 13, 18, 19], "place": [2, 4, 11], "same": [2, 4, 6, 9, 11, 13, 18], "script": [2, 11, 18], "see": [2, 4, 9, 11, 13, 18], "python": [2, 11, 13, 16], "direct": [2, 11], "implement": [2, 11], "import": [2, 4, 11, 13, 18, 19], "pl": 2, "now": 2, "specifi": [2, 4, 6, 11, 18], "via": 2, "next": 2, "step": [2, 4, 11, 13], "creat": [2, 4, 6, 11, 13], "object": [2, 4, 6, 7, 9, 11, 13, 19], "dir": 2, "0": [2, 4, 7, 11, 13, 18, 19], "fa_acid_amide_c": 2, "fa_squaramide_se_c": 2, "fa_donor_acceptor_nosym": 2, "3": [2, 4, 13], "geo_nosym": 2, "base_dir": 2, "__file__": 2, "parent": [2, 11, 13], "calc_dir": [2, 5, 6, 7, 13, 18, 19], "calc_r": 2, "vdd_manag": 2, "create_vdd_charge_manag": [2, 5, 6], "name": [2, 4, 5, 6, 9, 11, 13, 18], "total": [2, 6, 13, 19], "well": [2, 4, 13, 18, 19], "each": [2, 4, 6, 11, 13], "To": [2, 11, 18], "content": [2, 3], "simpli": [2, 4, 18], "print": [2, 4, 6, 18], "ar": [2, 4, 6, 7, 9, 11, 13, 18], "format": [2, 4, 7, 11, 13, 18], "tabl": [2, 3, 4, 6], "unit": [2, 4, 5, 6, 11], "milli": 2, "electron": [2, 4, 6, 13], "me": [2, 6], "alwai": [2, 4, 11], "chang": [2, 4, 6, 7, 11, 18], "method": [2, 4, 6, 11, 13, 18], "e": [2, 4, 6, 11, 13, 19], "standard": [2, 9, 13], "output": [2, 4, 11, 13], "frag": [2, 4, 18], "aa": [2, 13, 19], "aaa": [2, 13, 19], "1c": 2, "40": [2, 4], "10": [2, 4, 11, 18], "30": [2, 4], "2se": 2, "165": 2, "134": 2, "3c": [2, 11], "4se": 2, "5c": 2, "26": [2, 4], "122": 2, "96": [2, 9], "6c": 2, "7n": 2, "62": 2, "88": 2, "150": 2, "8h": 2, "53": 2, "55": 2, "9h": 2, "63": 2, "56": 2, "10n": 2, "11h": 2, "12h": 2, "sum": [2, 6, 13], "357": 2, "164": 2, "521": 2, "It": [2, 4, 6, 9, 11, 13, 18], "easi": [2, 18], "up": [2, 4, 9, 11, 18], "molecul": [2, 3, 6, 7, 11, 13, 18], "case": [2, 4, 9, 11, 13, 18], "also": [2, 4, 11, 13, 18, 19], "irrep": [2, 5, 6, 13], "equal": [2, 11, 13], "should": [2, 4, 7, 9, 11, 13], "possibl": [2, 4, 7, 13, 18], "both": [2, 4, 11], "txt": 2, "excel": [2, 6], "xlsx": 2, "further": [2, 4, 13], "output_dir": [2, 6], "write": [2, 6, 11], "static": [2, 6], "becaus": [2, 6], "multipl": [2, 4, 6, 7, 11, 13], "written": [2, 4, 6, 9, 11, 13, 16], "write_to_txt": [2, 5, 6], "an": [2, 4, 6, 9, 11, 13, 18], "write_to_excel": [2, 5, 6], "visual": 2, "plot": [2, 6], "bar": [2, 4, 6], "graph": [2, 6], "matplotlib": 2, "save": [2, 3, 4, 18], "png": 2, "per": [2, 6, 13], "plot_vdd_charges_per_atom": [2, 5, 6], "final": [2, 13], "made": [2, 4, 9], "singl": [2, 4, 11, 13, 18], "compar": [2, 4, 7], "combin": [2, 4], "calc": 2, "valu": [2, 4, 7, 9, 11, 13], "re": [2, 13], "zip": 2, "19": 2, "18": 2, "2o": 2, "8": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17, 18, 19], "49": 2, "41": 2, "3se": 2, "68": 2, "5": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17, 18, 19], "4o": 2, "34": 2, "27": 2, "61": 2, "6h": 2, "6": [2, 4, 9, 13, 18], "7h": 2, "4": [2, 4], "44": 2, "9n": 2, "46": 2, "42": 2, "10h": 2, "32": [2, 18], "31": 2, "2c": 2, "4c": 2, "5h": 2, "12o": 2, "13o": 2, "14n": 2, "13": 2, "15h": 2, "16h": 2, "17h": 2, "9": 2, "18h": 2, "20": [2, 4], "105": 2, "2h": 2, "67": 2, "11": 2, "3h": 2, "16": [2, 18], "4h": 2, "17": [2, 13, 19], "166": 2, "6o": 2, "291": 2, "116": 2, "158": 2, "21": 2, "84": 2, "11c": 2, "213": 2, "253": 2, "13n": 2, "235": 2, "14h": 2, "54": 2, "14": 2, "59": 2, "15": [2, 4], "16c": 2, "45": 2, "22": 2, "17c": 2, "23": [2, 9], "18c": 2, "50": [2, 4], "24": 2, "19c": 2, "25": 2, "20c": 2, "21c": 2, "64": 2, "12": 2, "22h": 2, "65": 2, "23h": 2, "52": 2, "24h": 2, "48": 2, "25h": 2, "here": [2, 11, 18], "class": [2, 4, 6, 11, 13, 16], "central": 2, "inform": [2, 4, 9, 13, 19], "dictionari": [2, 4, 9, 13], "present": [2, 4, 13], "kei": [2, 4, 9, 13], "doe": [2, 4, 11, 18], "onli": [2, 4, 7, 13], "itself": [2, 13], "index": [2, 4, 7, 13, 16], "belong": [2, 4, 9, 13], "subpackag": 3, "analysi": [3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "modul": [3, 18], "job": [3, 4, 13], "submodul": [3, 5, 19], "crest": [3, 4, 18], "dftb": [3, 4, 18, 19], "gener": [3, 4, 13, 18], "nmr": [3, 4, 18], "orca": [3, 4, 9, 18], "cach": 3, "type": [3, 4, 11, 13], "arrai": [3, 4, 7, 13], "timed_cach": [3, 4], "constant": [3, 11, 16], "formula": [3, 11], "parse_molecul": [3, 4], "geometri": [3, 11, 13, 18], "transform": [3, 4, 13], "appli": [3, 4, 7, 18], "combine_transform": [3, 4], "translat": [3, 4], "rotat": [3, 4], "scale": [3, 4, 13], "kabschtransform": [3, 4], "get_rotmat": [3, 4], "apply_rotmat": [3, 4], "vector_align_rotmat": [3, 4], "rmsd": [3, 4], "random_points_on_spher": [3, 4], "random_points_in_anular_spher": [3, 4], "log": 3, "emoji": [3, 4], "wait": [3, 4, 11, 18], "good": [3, 4, 11, 18], "cancel": [3, 4, 11], "sleep": [3, 4], "fail": [3, 4, 11, 13], "send": [3, 4], "receiv": [3, 4], "empti": [3, 4, 11, 13], "warn": [3, 4, 13], "question": [3, 4], "info": [3, 4, 13, 19], "rarrow": [3, 4], "larrow": [3, 4], "lrarrow": [3, 4], "rlarrow": [3, 4], "angstrom": [3, 4, 9, 11], "noprint": [3, 4], "time_stamp": [3, 4], "loadbar": [3, 4], "box": [3, 4], "debug": [3, 4], "error": [3, 4, 13, 18], "critic": [3, 4], "caller_nam": [3, 4], "parse_str": [3, 4], "guess_frag": [3, 4, 18], "report": 3, "si": [3, 4], "add_xyz": [3, 4], "add_head": [3, 4], "slurm": [3, 11], "has_slurm": [3, 4], "squeue": [3, 4, 11], "sbatch": [3, 4, 11, 18], "workdir_info": [3, 4], "wait_for_job": [3, 4], "ensure_list": [3, 4], "squeeze_list": [3, 4], "ensure_2d": [3, 4], "vibrat": [4, 5, 11, 13, 19], "ts_vibrat": [4, 5], "adfjob": [4, 11, 18], "basis_set": [3, 4, 11, 18], "spin_polar": [4, 11, 13], "unrestrict": [4, 11, 13], "qualiti": [4, 11, 13, 18], "scf_converg": [4, 11], "rel": [4, 7, 11], "solvent": [4, 11], "adffragmentjob": [4, 11, 18], "add_frag": [4, 11, 18], "run": [4, 11, 13, 18], "amsjob": [4, 11], "single_point": [4, 11], "geometry_converg": [4, 11], "transition_st": [4, 11], "optim": [4, 11, 13, 18], "output_mol_path": [4, 11], "crestjob": [4, 11, 18], "md_temperatur": [4, 11], "md_length": [4, 11], "best_conformer_path": [4, 11], "conformer_directori": [4, 11], "rotamer_directori": [4, 11], "get_conformer_xyz": [4, 11, 18], "get_rotamer_xyz": [4, 11], "qcgjob": [4, 11, 18], "nsolv": [4, 11], "alpb": [4, 11], "ensemble_mod": [4, 11], "nofix": [4, 11], "ensemble_directori": [4, 11], "get_ensemble_xyz": [4, 11], "best_ensemble_path": [4, 11], "dftbjob": [4, 11, 18], "kspace": [4, 11], "model": [4, 11, 18], "can_skip": [4, 11], "add_preambl": [4, 11], "add_postambl": [4, 11], "depend": [4, 11, 13], "workdir": [4, 11, 18], "runfile_path": [4, 11], "inputfile_path": [4, 11], "nmrjob": [4, 11, 18], "add_nics_point": [4, 11], "orcajob": [4, 11, 18], "get_memory_usag": [4, 11], "get_input": [4, 11, 13], "get_calc_set": [4, 13], "get_properti": [4, 13], "get_level_of_theori": [4, 13], "get_calc_fil": [4, 13], "get_ams_vers": [4, 13], "get_ams_info": [4, 13], "get_tim": [4, 13], "get_calculation_statu": [4, 13], "get_molecul": [4, 9, 13], "get_histori": [4, 13], "get_input_block": [4, 13], "get_ams_input": [4, 13], "trackkfread": [4, 13], "store": [4, 9, 13], "get": [4, 6, 9, 13, 18], "unload": [4, 13], "get_vers": [4, 13], "get_info": [4, 13], "get_vibr": [4, 13], "item": [4, 13, 18], "get_parent_tre": [4, 13], "prune": [4, 13], "get_multi_kei": [4, 13], "as_plams_set": [4, 13], "delai": 4, "float": [4, 6, 7, 11, 13], "sourc": [4, 6, 7, 9, 11, 13], "decor": 4, "time": [4, 13], "expir": 4, "after": [4, 11, 13], "chosen": [4, 13], "amount": [4, 13], "paramet": [4, 7, 9, 11, 13], "expiri": 4, "func": [4, 6], "previou": 4, "call": [4, 11, 13, 19], "str": [4, 6, 7, 9, 11, 13], "return": [4, 7, 9, 11, 13], "molstr": 4, "describ": [4, 13], "its": [4, 9, 13], "part": [4, 9], "separ": 4, "sign": [4, 7], "new": [4, 11, 13, 18], "string": [4, 13], "plam": [4, 7, 11, 13], "pars": [4, 9, 13], "mode": [4, 7, 11, 13], "unicod": 4, "show": 4, "properli": 4, "latex": 4, "html": [4, 13], "either": [4, 13], "reaction": [4, 7, 11], "formatt": 4, "convert": [4, 13], "render": 4, "nice": [4, 6], "base": [4, 6, 7, 11, 13, 18], "matrix": 4, "set": [4, 9, 11, 13, 18, 19], "3d": 4, "coordin": [4, 7, 11, 13], "build": [4, 11, 18], "4x4": 4, "encod": 4, "textbf": 4, "m": 4, "begin": 4, "bmatrix": 4, "r": [4, 13], "diag": 4, "": [4, 9, 11, 13, 19], "t": [4, 11, 18], "_3": 4, "end": [4, 13], "where": [4, 13, 18], "mathbb": 4, "x": [4, 11], "y": [4, 11], "z": [4, 11], "n": [4, 13, 18], "simultan": 4, "v": 4, "ndarrai": [4, 7], "vector": 4, "applic": 4, "three": [4, 18], "process": [4, 13], "append": 4, "row": 4, "ones": [4, 11], "bottom": 4, "remov": [4, 11, 13], "been": 4, "__call__": 4, "redirect": [4, 11], "coord": 4, "two": [4, 6, 13], "differ": [4, 7, 13, 18], "involv": 4, "multipli": [4, 11], "matric": 4, "assign": 4, "one": [4, 7, 11, 13, 18, 19], "product": 4, "origin": 4, "left": 4, "side": 4, "right": 4, "__matmul__": 4, "none": [4, 6, 7, 9, 11, 13], "add": [4, 11, 13, 18], "compon": 4, "argument": [4, 7, 11], "given": [4, 7, 9, 11, 13, 18, 19], "thei": [4, 13, 18], "3x3": 4, "angl": [4, 11], "along": 4, "ax": 4, "kabsch": 4, "umeyama": 4, "algorithm": 4, "t_": 4, "minim": [4, 11], "arg": [4, 11, 13], "min_": 4, "numer": [4, 11, 13], "stabl": 4, "work": [4, 11, 13, 16, 18], "covari": 4, "singular": 4, "point": [4, 7, 11, 13, 18], "must": [4, 11], "size": [4, 11, 13], "center": 4, "onto": 4, "centroid": 4, "befor": [4, 7, 11, 18], "determin": [4, 7, 18], "yield": [4, 7], "second": [4, 7], "target": 4, "principl": [4, 11], "care": 4, "about": [4, 9, 13], "dimens": 4, "howev": 4, "our": [4, 18], "most": 4, "common": [4, 13, 18], "would": [4, 9, 11, 18], "like": [4, 11, 13, 18, 19], "make": [4, 11, 18], "2d": 4, "1d": [4, 13], "suggest": 4, "correct": [4, 9, 11, 13, 18], "zero": [4, 11], "main": [4, 13], "numpi": [4, 13], "np": 4, "arang": 4, "reshap": 4, "tx": 4, "tkabsch": 4, "check": [3, 4, 6, 7, 11, 13], "assert": 4, "isclos": 4, "refer": [4, 13, 18], "http": [4, 13], "en": 4, "wikipedia": 4, "org": [4, 13], "wiki": 4, "orthogonal_procrustes_problem": 4, "kabsch_algorithm": 4, "tait": 4, "bryant": 4, "sytem": 4, "system": [4, 11, 13], "around": 4, "correspond": [4, 9, 13], "hand": 4, "convent": [4, 7], "axi": 4, "radian": 4, "directli": 4, "allow": [4, 13, 18], "math": 4, "b": [4, 18], "align": 4, "int": [4, 6, 7, 9, 11, 13], "use_kabsch": 4, "bool": [4, 6, 7, 9, 11, 13], "true": [4, 7, 11, 13], "root": 4, "mean": [4, 11], "squar": 4, "deviat": 4, "By": [4, 11], "default": [4, 7, 11], "prior": [4, 11], "option": [4, 7, 11, 13, 18], "frac": 4, "sqrt": [4, 11], "sum_i": 4, "x_i": 4, "y_i": 4, "obtain": [4, 7, 13], "have": [4, 11, 13], "whether": [4, 7, 9, 11, 13], "integ": [4, 13], "recommend": [4, 13, 19], "enabl": [4, 11, 13, 19], "ensur": [4, 18], "lowest": [4, 7, 18], "shape": 4, "tupl": [4, 11], "radiu": [4, 9, 11], "random": 4, "sphere": 4, "min_radiu": 4, "max_radiu": 4, "radii": [4, 11], "largest": 4, "some": [4, 11, 17, 18], "charact": [4, 13], "support": [4, 11], "dot": [4, 13], "notat": [4, 13], "g": [4, 11, 13, 19], "\u2139": 4, "\u00e5": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "stdout": 4, "stderr": 4, "context": [4, 11, 18], "suppress": 4, "temporari": 4, "delet": [4, 13], "exit": [4, 18], "current": [4, 18], "timestamp": 4, "yyyi": 4, "mm": 4, "dd": 4, "hh": 4, "ss": 4, "messag": 4, "tag": [4, 9], "straight": 4, "level": [4, 11, 13, 18], "flowchart": 4, "prepend": 4, "element": [4, 7, 9, 13], "arrow": 4, "line": [4, 11, 13, 18], "ani": [4, 11, 13, 18], "header": 4, "sep": 4, "hline": 4, "cast": 4, "nrow": 4, "sequenc": [4, 6, 11], "ncol": 4, "data": [3, 4, 7, 11, 13], "insid": [4, 13], "repres": 4, "column": 4, "top": 4, "drawn": 4, "neg": [4, 7, 11], "indic": [4, 11, 13], "draw": 4, "iter": 4, "comment": 4, "nsegment": 4, "nstep": 4, "progress": 4, "over": [4, 11], "defin": [4, 7, 13, 18], "__len__": 4, "give": [4, 11, 13], "length": [4, 7, 11], "number": [4, 7, 9, 11, 13, 18], "dure": [4, 11, 13], "tty": 4, "stream": 4, "titl": 4, "message_align": 4, "title_align": 4, "round_corn": 4, "double_edg": 4, "fals": [4, 7, 11, 13], "surround": 4, "multilin": 4, "edg": 4, "One": [4, 13, 18, 19], "corner": 4, "round": 4, "doubl": 4, "full": [4, 13, 18, 19], "caller": 4, "skip": [4, 11, 13], "formatte": 4, "multi": 4, "split": 4, "escap": 4, "verbos": 4, "follow": [4, 9, 11, 13, 18], "notset": 4, "__str__": 4, "dict": [4, 6, 13, 19], "json": 4, "against": [4, 7], "wide": 4, "log_level": 4, "variabl": [4, 13], "do": [4, 18], "usual": [4, 11], "custom": 4, "xyz": [4, 11, 18], "flag": 4, "provid": [4, 7, 11, 13], "structur": [4, 13, 18], "atom_tag1": 4, "atom_tag2": 4, "atom_key1": 4, "mol_tag1": 4, "mol_tag2": 4, "mol_key1": 4, "mol_key2": 4, "respect": 4, "similarli": 4, "guess": [4, 13], "fragment": [4, 6, 13, 18], "tab": 4, "00000000": [4, 18], "81474153": [4, 18], "83567034": [4, 18], "h": [4, 18], "47608351": [4, 18], "82460084": [4, 18], "14410295": [4, 18], "95216703": [4, 18], "58149793": [4, 18], "00718395": [4, 18], "13712667": [4, 18], "16299585": [4, 18], "frag_donor": 4, "frag_acceptor": 4, "prefix": 4, "frag_": 4, "rang": 4, "donor": [4, 18], "acceptor": [4, 18], "mark": 4, "shown": 4, "abov": [4, 11], "were": [4, 13], "obj": 4, "bond": [4, 7, 13], "energi": [4, 11, 13, 19], "gibb": [4, 13], "free": [4, 13], "enthalpi": [4, 13], "imaginari": [4, 7, 11, 13], "head": 4, "docx": 4, "platform": [4, 18], "statu": [4, 11, 13], "id": [4, 11, 13], "statuscod": 4, "lessen": 4, "hpc": 4, "runfil": [4, 11], "submit": [4, 11, 18], "filenam": [4, 13], "command": 4, "being": [4, 13], "activ": [4, 7], "referenc": 4, "slurmid": 4, "check_everi": 4, "everi": 4, "again": 4, "don": [4, 18], "put": 4, "too": 4, "high": [4, 13], "anger": 4, "cluster": [4, 18], "peopl": 4, "transpos": 4, "atom_index": [5, 6], "atom_symbol": [5, 6, 13], "frag_index": [5, 6], "change_unit_decor": [5, 6], "vdd_charg": [5, 6], "is_fragment_calcul": [5, 6], "mol_charg": [5, 6], "charge_is_conserv": [5, 6], "get_vdd_charg": [5, 6], "get_summed_vdd_charg": [5, 6], "get_vdd_charges_datafram": [5, 6], "get_summed_vdd_charges_datafram": [5, 6], "get_vdd_charges_t": [5, 6], "get_summed_vdd_charges_t": [5, 6], "avg_relative_bond_length_delta": [5, 7], "determine_ts_reactioncoordin": [5, 7], "validate_transitionst": [5, 7], "ratio": 6, "them": [6, 11, 13], "conserv": 6, "new_unit": 6, "mili": 6, "datafram": 6, "panda": 6, "output_fil": 6, "sheet": 6, "po": 7, "atom1": 7, "atom2": 7, "distanc": [4, 7, 11], "ad": [7, 13], "subtract": 7, "label": [7, 13, 19], "averag": 7, "baselin": 7, "select": [7, 9, 11, 13], "percentag": 7, "mode_index": 7, "bond_toler": 7, "28": 7, "min_delta_dist": 7, "retriev": [7, 13, 19], "transitionst": [7, 13], "frequenc": [7, 11, 13], "analyz": 7, "guess_bond": 7, "minimum": [7, 13], "qualifi": 7, "count": [7, 11], "active_atom1": 7, "active_atom2": 7, "reactioncoordin": 7, "ignor": [4, 7], "increas": 7, "rcatom": 7, "analyze_mod": 7, "kwarg": [4, 7, 11, 13], "expect": [7, 13], "user": [7, 13], "input": [4, 7, 9, 11, 13, 18], "section": [7, 13], "desir": [7, 13], "atomlabel1": 7, "atomlabel2": 7, "order": [7, 13], "keyword": 7, "boolean": 7, "otherwis": [7, 11, 13, 18], "least": 7, "typ": 11, "tz2p": [11, 18], "core": [11, 13, 18], "basi": [11, 13], "frozen": [11, 13], "approxim": [11, 13], "r2scan": 11, "mtz2p": 11, "val": [9, 11], "spin": [11, 13], "polar": [11, 13], "singlet": 11, "doublet": 11, "triplet": 11, "gui": [11, 18], "thresh": 11, "1e": 11, "08": 11, "scf": [11, 13], "converg": 11, "criteria": 11, "procedur": 11, "funtional_nam": 11, "dispers": [9, 11, 13], "pleas": [11, 18], "get_available_funct": [4, 9], "want": [9, 11, 13, 18], "libxc": [9, 11], "automat": [11, 13, 18], "scalar": 11, "treatment": 11, "relativist": [11, 13], "effect": [11, 13], "ep": 11, "rad": 11, "use_klamt": 11, "solvat": [11, 18], "cosmo": [3, 4, 11], "manual": 11, "dielectr": 11, "your": [11, 18], "more": [4, 11, 18], "control": [11, 18], "klamt": 11, "speci": 11, "detect": [11, 18], "local": [11, 18], "serv": 11, "futur": 11, "bandjob": 11, "hold": 11, "relat": [11, 13, 18], "prepar": [11, 18], "task": [11, 13, 18], "gradient": [11, 13], "05": 11, "dihedr": 11, "modetofollow": 11, "search": [11, 16, 18], "acceler": 11, "normal": [9, 11], "atom_index1": 11, "atom_index2": 11, "factor": 11, "start": [11, 13, 18], "atom_index3": 11, "atom_index4": 11, "pespointcharact": [], "negativefrequenciestoler": 11, "rescanfreqrang": [], "10000000": [], "pe": 13, "toler": 11, "experi": 11, "lot": 11, "nois": 11, "rescan": [], "refin": [], "properti": [11, 13, 18, 19], "singlepoint": [11, 13], "temperatur": 11, "dynam": 11, "400k": 11, "conform": [11, 18], "alreadi": [9, 11], "exist": [4, 9, 11, 18], "wa": [11, 13], "rotam": [11, 18], "setup": 11, "tight": [11, 18], "bind": [11, 18], "amsterdam": [11, 18], "suit": [11, 18], "k": 11, "space": 11, "integr": 11, "gfn1": 11, "xtb": 11, "parameter_dir": 11, "hamiltonian": 11, "grid_siz": 11, "974": 11, "gbsa": 11, "aceton": 11, "acetonitril": 11, "chcl3": 11, "cs2": 11, "dmso": 11, "ether": 11, "h2o": 11, "methanol": 11, "thf": 11, "toluen": 11, "grid": 11, "access": [11, 13, 18, 19], "surfac": 11, "230": 11, "2030": 11, "5810": 11, "test_mod": 11, "overwrit": 11, "wait_for_finish": 11, "advanc": 11, "__enter__": 11, "__exit__": 11, "syntax": 11, "safe": [9, 11], "_setup_job": 11, "overwritten": 11, "know": [9, 11, 18], "what": 11, "look": 11, "real": 11, "previous": 11, "continu": 11, "runscript": [11, 18], "fatal": [11, 13], "could": [4, 11], "those": 11, "yet": [11, 13, 18], "latter": 11, "rerun": 11, "fix": 11, "later": [11, 13], "version": [11, 13, 16], "partit": [11, 18], "tc": [11, 18], "p": [11, 18], "note": 11, "dash": 11, "cannot": [11, 13], "underscor": 11, "job_nam": 11, "water_dimer_go": 11, "few": [11, 18], "extra": [11, 13], "d": [11, 13], "chdir": 11, "self": 11, "sure": 11, "j": 11, "rundir": [11, 18], "nicer": 11, "o": [11, 18], "out": [11, 13], "wish": 11, "preambl": 11, "come": 11, "shebang": 11, "ran": [11, 18], "program": [11, 13, 16], "specif": [11, 13, 18, 19], "2023": 11, "101": 11, "postambl": 11, "copi": 11, "t12": 11, "rm": 11, "otherjob": 11, "anoth": [11, 18], "sens": 11, "back": 11, "variou": [4, 11, 18], "nuclear": [11, 13, 18], "magnet": [11, 18], "reson": [11, 18], "chemic": 11, "shift": 11, "saop": 11, "theori": [11, 13, 18], "nic": 11, "cartesian": 11, "relativistic_typ": 13, "unrestricted_sfo": 13, "sfo": 13, "treat": 13, "manner": 13, "unrestricted_mo": 13, "mo": 13, "group": [13, 16, 19], "associ": 13, "used_region": 13, "region": 13, "elstat": 13, "electrostat": 13, "potenti": 13, "orbint": [13, 19], "orbit": 13, "pauli": 13, "repuls": 13, "popul": 13, "nuclear_intern": 13, "intern": [13, 17], "number_of_mod": 13, "3n": 13, "linear": 13, "number_of_imaginary_mod": 13, "sort": 13, "low": 13, "intens": 13, "nparrai": 13, "denisti": 13, "initi": 13, "inp_path": 13, "summari": 13, "human": 13, "readabl": 13, "xc": [9, 13], "categori": [9, 13], "gga": 13, "metahybrid": 13, "etc": 13, "empiricalsc": 13, "empir": [9, 13], "mp2": 13, "scm": 13, "major": 13, "year": 13, "releas": 13, "minor": 13, "micro": 13, "revis": 13, "date": 13, "datetim": 13, "ams_vers": [13, 19], "job_id": 13, "might": 13, "uniqu": 13, "identifi": 13, "is_multijob": 13, "multijob": 13, "histori": 13, "cpu": 13, "spent": 13, "sy": 13, "io": 13, "creation": 13, "destruct": 13, "larger": 13, "than": [4, 13], "reader": 13, "succ": 13, "reason": 13, "kfreader": 13, "kffile": 13, "correctli": 13, "explain": 13, "success": 13, "unknown": 13, "w": 13, "u": [13, 18], "f": [13, 18], "els": [9, 13], "number_of_atom": 13, "atom_numb": 13, "atom_mass": 13, "mass": 13, "frag_indic": 13, "number_of_entri": 13, "natur": 13, "scan": 13, "input_block": 13, "block": 13, "parentblock": 13, "subblock": 13, "subsubblock": 13, "nonstandard": 13, "subsubsubblock": 13, "within": 13, "special": [13, 18], "entri": 13, "inp": 13, "tini": 13, "take": [11, 13], "long": 13, "open": [13, 18], "especi": 13, "so": [13, 16], "better": 13, "onc": 13, "subclass": [13, 18], "track": 13, "figur": 13, "trim": 13, "reduc": 13, "files": 13, "tracker": 13, "storag": 13, "sinc": 13, "quit": [4, 13, 18], "larg": 13, "forget": [13, 18], "lest": 13, "memori": 13, "issu": [13, 18], "kf": 13, "claus": 13, "transitionstatesearch": 13, "usedqro": 13, "qro": 13, "wavefunct": 13, "used_qro": 13, "saddlepoint": 13, "n_imag": 13, "entropi": 13, "certain": 13, "hf": 13, "ccsd": 13, "_corr": 13, "correl": 13, "t1": 13, "diagnost": 13, "highest": 13, "valid": 13, "s2": 13, "oper": 13, "s2_expect": 13, "ideal": 13, "spin_contamin": 13, "contamin": 13, "observ": 13, "insensit": 13, "retain": 13, "overrid": 13, "hide": 13, "dunder": 13, "expos": 13, "view": 13, "multikei": 13, "join": 13, "gotten": 13, "basic": [11, 13], "done": [13, 19], "band": [9, 13, 19], "typic": [13, 18], "easili": [13, 18, 19], "just": [13, 19], "_": 13, "fixtur": [13, 19], "ethanol": [13, 19], "2022": [13, 19], "103": [13, 19], "r104886": [13, 19], "06": [13, 19], "c": [9, 13, 19], "2738": [13, 19], "644830445246": [13, 19], "1056": [13, 19], "9706925183411": [13, 19], "3795": [13, 19], "615522963587": [13, 19], "number_of_imag_mod": [13, 19], "_dict": 13, "doc": 13, "librari": [9, 13, 16], "stdtype": 13, "master": 13, "mani": 16, "helper": 16, "theochem": 16, "overview": [9, 11, 16], "page": [16, 18], "heavi": [16, 18], "develop": [16, 18], "guarante": 16, "older": 16, "newer": 16, "small": 17, "help": 17, "offer": 18, "tool": 18, "effici": [4, 18], "comput": 18, "useful": 18, "lift": 18, "background": 18, "while": 18, "cleaner": 18, "proof": 18, "won": 18, "molecule_1": 18, "adf_calcul": 18, "featur": 18, "abl": 18, "instead": [4, 18], "crest_job": 18, "conformer_xyz": 18, "enumer": 18, "opt_job": 18, "olyp": 18, "d3": 18, "bj": 18, "conformer_": 18, "regular": 18, "ensembl": 18, "sampl": 18, "quantum": 18, "growth": 18, "qcg": 18, "explicit": 18, "github": 18, "let": 18, "licens": 18, "execut": 18, "click": 18, "simpl": 18, "water": 18, "dimer": 18, "bp86": 18, "enter": 18, "appear": 18, "pretti": 18, "much": 18, "everyth": 18, "go_water_dim": 18, "download": 18, "water_dim": 18, "61075942": 18, "14972207": 18, "27324620": 18, "14984188": 18, "05173067": 18, "71502154": 18, "65160034": 18, "06225163": 18, "52042212": 18, "38869649": 18, "77034720": 18, "kind": 18, "littl": 18, "nh3bh3": 18, "fragment_nam": 18, "spell_check": 3, "naive_recurs": [3, 4], "wagner_fisch": [3, 4], "get_closest": [3, 4], "make_suggest": [3, 4], "caller_level": 4, "na\u00efv": 4, "recurs": 4, "levenshtein": 4, "slow": 4, "faster": 4, "altern": 4, "25x": 4, "substitution_cost": 4, "case_missmatch_cost": 4, "insertion_cost": 4, "wagner": 4, "fischer": 4, "penalti": 4, "incur": 4, "erron": 4, "substitut": 4, "miss": 4, "match": 4, "cost": 4, "insert": 4, "kitten": 4, "sit": 4, "slower": 4, "compare_func": 4, "ignore_cas": 4, "ignore_char": 4, "maximum_dist": 4, "similar": 4, "rest": 4, "collect": 4, "taken": [4, 11], "account": 4, "turn": 4, "lower": [4, 9], "comparison": 4, "maximum": [4, 11], "greater": 4, "closest": 4, "mitten": 4, "bitten": 4, "close": 4, "2024": 4, "01": [4, 11], "35": 4, "find": 4, "did": 4, "postscript": [4, 11], "clean_workdir": [4, 11], "split_crest_xyz": [4, 11], "write_converged_geom": [4, 11], "irc": [4, 11], "add_postscript": [4, 11], "hess_fil": 11, "step_siz": 11, "min_path_length": 11, "max_point": 11, "300": 11, "intrins": 11, "hessian": 11, "constrain": 11, "a_0": 11, "da": 11, "switch": 11, "Be": 11, "preset": 11, "verybas": 11, "verygood": 11, "threshold": 11, "atom_data_info": [4, 9], "parse_el": [4, 9], "color": [4, 9], "functional_name_from_path_safe_nam": [4, 9], "symbol": 9, "hydrogen": 9, "coval": 9, "cpk": 9, "109": 9, "functional_nam": 9, "path_safe_nam": 9, "suitabl": 9, "without": 9, "parenthes": 9, "asterisk": 9, "replac": 9, "name_no_disp": 9, "dispersion_nam": 9, "includes_disp": 9, "use_libxc": 9, "available_in_adf": 9, "available_in_band": 9, "available_in_orca": 9, "adf_set": 9, "rais": 11, "valueerror": 11, "incorrect": 11, "recogn": 11}, "objects": {"": [[4, 0, 0, "-", "tcutility"]], "tcutility": [[5, 0, 0, "-", "analysis"], [4, 0, 0, "-", "cache"], [4, 0, 0, "-", "constants"], [9, 0, 0, "-", "data"], [4, 4, 1, "", "ensure_2d"], [4, 4, 1, "", "ensure_list"], [4, 0, 0, "-", "formula"], [4, 0, 0, "-", "geometry"], [11, 0, 0, "-", "job"], [4, 0, 0, "-", "log"], [4, 0, 0, "-", "molecule"], [4, 0, 0, "-", "report"], [13, 0, 0, "-", "results"], [4, 0, 0, "-", "slurm"], [4, 0, 0, "-", "spell_check"], [4, 4, 1, "", "squeeze_list"], [14, 0, 0, "-", "typing"]], "tcutility.analysis": [[6, 0, 0, "-", "vdd"], [7, 0, 0, "-", "vibration"]], "tcutility.analysis.vdd": [[6, 0, 0, "-", "charge"], [6, 0, 0, "-", "manager"]], "tcutility.analysis.vdd.charge": [[6, 1, 1, "", "VDDCharge"]], "tcutility.analysis.vdd.charge.VDDCharge": [[6, 2, 1, "", "atom_index"], [6, 2, 1, "", "atom_symbol"], [6, 3, 1, "", "change_unit"], [6, 2, 1, "", "charge"], [6, 2, 1, "", "frag_index"]], "tcutility.analysis.vdd.manager": [[6, 1, 1, "", "VDDChargeManager"], [6, 4, 1, "", "change_unit_decorator"], [6, 4, 1, "", "create_vdd_charge_manager"]], "tcutility.analysis.vdd.manager.VDDChargeManager": [[6, 2, 1, "", "calc_dir"], [6, 3, 1, "", "change_unit"], [6, 3, 1, "", "charge_is_conserved"], [6, 3, 1, "", "get_summed_vdd_charges"], [6, 3, 1, "", "get_summed_vdd_charges_dataframe"], [6, 3, 1, "", "get_summed_vdd_charges_table"], [6, 3, 1, "", "get_vdd_charges"], [6, 3, 1, "", "get_vdd_charges_dataframe"], [6, 3, 1, "", "get_vdd_charges_table"], [6, 2, 1, "", "irreps"], [6, 2, 1, "", "is_fragment_calculation"], [6, 2, 1, "", "mol_charge"], [6, 2, 1, "", "name"], [6, 3, 1, "", "plot_vdd_charges_per_atom"], [6, 2, 1, "", "unit"], [6, 2, 1, "", "vdd_charges"], [6, 3, 1, "", "write_to_excel"], [6, 3, 1, "", "write_to_txt"]], "tcutility.analysis.vibration": [[7, 0, 0, "-", "ts_vibration"]], "tcutility.analysis.vibration.ts_vibration": [[7, 4, 1, "", "avg_relative_bond_length_delta"], [7, 4, 1, "", "determine_ts_reactioncoordinate"], [7, 4, 1, "", "validate_transitionstate"]], "tcutility.cache": [[4, 4, 1, "", "cache"], [4, 4, 1, "", "timed_cache"]], "tcutility.data": [[9, 0, 0, "-", "atom"], [10, 0, 0, "-", "atom_data_info"], [9, 0, 0, "-", "basis_sets"], [9, 0, 0, "-", "cosmo"], [9, 0, 0, "-", "functionals"], [9, 0, 0, "-", "molecules"]], "tcutility.data.atom": [[9, 4, 1, "", "color"], [9, 4, 1, "", "parse_element"], [9, 4, 1, "", "radius"]], "tcutility.data.functionals": [[9, 4, 1, "", "functional_name_from_path_safe_name"], [9, 4, 1, "", "get"], [9, 4, 1, "", "get_available_functionals"]], "tcutility.data.molecules": [[9, 4, 1, "", "get"], [9, 4, 1, "", "get_molecules"]], "tcutility.formula": [[4, 4, 1, "", "molecule"], [4, 4, 1, "", "parse_molecule"]], "tcutility.geometry": [[4, 1, 1, "", "KabschTransform"], [4, 4, 1, "", "RMSD"], [4, 1, 1, "", "Transform"], [4, 4, 1, "", "apply_rotmat"], [4, 4, 1, "", "get_rotmat"], [4, 4, 1, "", "random_points_in_anular_sphere"], [4, 4, 1, "", "random_points_on_sphere"], [4, 4, 1, "", "rotate"], [4, 4, 1, "", "vector_align_rotmat"]], "tcutility.geometry.Transform": [[4, 3, 1, "", "apply"], [4, 3, 1, "", "combine_transforms"], [4, 3, 1, "", "rotate"], [4, 3, 1, "", "scale"], [4, 3, 1, "", "translate"]], "tcutility.job": [[11, 0, 0, "-", "adf"], [11, 0, 0, "-", "ams"], [11, 0, 0, "-", "crest"], [11, 0, 0, "-", "dftb"], [11, 0, 0, "-", "generic"], [11, 0, 0, "-", "nmr"], [11, 0, 0, "-", "orca"], [12, 0, 0, "-", "postscripts"]], "tcutility.job.adf": [[11, 1, 1, "", "ADFFragmentJob"], [11, 1, 1, "", "ADFJob"]], "tcutility.job.adf.ADFFragmentJob": [[11, 3, 1, "", "add_fragment"], [11, 3, 1, "", "run"]], "tcutility.job.adf.ADFJob": [[11, 3, 1, "", "SCF_convergence"], [11, 3, 1, "", "basis_set"], [11, 3, 1, "", "functional"], [11, 3, 1, "", "multiplicity"], [11, 3, 1, "", "quality"], [11, 3, 1, "", "relativity"], [11, 3, 1, "", "solvent"], [11, 3, 1, "", "spin_polarization"], [11, 3, 1, "", "unrestricted"]], "tcutility.job.ams": [[11, 1, 1, "", "AMSJob"]], "tcutility.job.ams.AMSJob": [[11, 3, 1, "", "IRC"], [11, 3, 1, "", "charge"], [11, 3, 1, "", "geometry_convergence"], [11, 3, 1, "", "optimization"], [11, 5, 1, "", "output_mol_path"], [11, 3, 1, "", "single_point"], [11, 3, 1, "", "transition_state"], [11, 3, 1, "", "vibrations"]], "tcutility.job.crest": [[11, 1, 1, "", "CRESTJob"], [11, 1, 1, "", "QCGJob"]], "tcutility.job.crest.CRESTJob": [[11, 5, 1, "", "best_conformer_path"], [11, 3, 1, "", "charge"], [11, 5, 1, "", "conformer_directory"], [11, 3, 1, "", "get_conformer_xyz"], [11, 3, 1, "", "get_rotamer_xyz"], [11, 3, 1, "", "md_length"], [11, 3, 1, "", "md_temperature"], [11, 3, 1, "", "multiplicity"], [11, 5, 1, "", "rotamer_directory"], [11, 3, 1, "", "spin_polarization"]], "tcutility.job.crest.QCGJob": [[11, 3, 1, "", "alpb"], [11, 5, 1, "", "best_ensemble_path"], [11, 5, 1, "", "ensemble_directory"], [11, 3, 1, "", "ensemble_mode"], [11, 3, 1, "", "get_ensemble_xyz"], [11, 3, 1, "", "nofix"], [11, 3, 1, "", "nsolv"], [11, 3, 1, "", "solvent"]], "tcutility.job.dftb": [[11, 1, 1, "", "DFTBJob"]], "tcutility.job.dftb.DFTBJob": [[11, 3, 1, "", "kspace"], [11, 3, 1, "", "model"], [11, 3, 1, "", "solvent"]], "tcutility.job.generic": [[11, 1, 1, "", "Job"]], "tcutility.job.generic.Job": [[11, 3, 1, "", "add_postamble"], [11, 3, 1, "", "add_postscript"], [11, 3, 1, "", "add_preamble"], [11, 3, 1, "", "can_skip"], [11, 3, 1, "", "dependency"], [11, 5, 1, "", "inputfile_path"], [11, 3, 1, "", "molecule"], [11, 5, 1, "", "output_mol_path"], [11, 3, 1, "", "run"], [11, 5, 1, "", "runfile_path"], [11, 3, 1, "", "sbatch"], [11, 5, 1, "", "workdir"]], "tcutility.job.nmr": [[11, 1, 1, "", "NMRJob"]], "tcutility.job.nmr.NMRJob": [[11, 3, 1, "", "add_nics_point"]], "tcutility.job.orca": [[11, 1, 1, "", "ORCAJob"]], "tcutility.job.orca.ORCAJob": [[11, 3, 1, "", "charge"], [11, 3, 1, "", "get_input"], [11, 3, 1, "", "get_memory_usage"], [11, 3, 1, "", "multiplicity"], [11, 3, 1, "", "optimization"], [11, 3, 1, "", "single_point"], [11, 3, 1, "", "spin_polarization"], [11, 3, 1, "", "transition_state"], [11, 3, 1, "", "vibrations"]], "tcutility.job.postscripts": [[12, 0, 0, "-", "clean_workdir"], [12, 0, 0, "-", "split_crest_xyz"], [12, 0, 0, "-", "write_converged_geoms"]], "tcutility.log": [[4, 1, 1, "", "Emojis"], [4, 1, 1, "", "NoPrint"], [4, 4, 1, "", "boxed"], [4, 4, 1, "", "caller_name"], [4, 4, 1, "", "critical"], [4, 4, 1, "", "debug"], [4, 4, 1, "", "error"], [4, 4, 1, "", "flow"], [4, 4, 1, "", "info"], [4, 4, 1, "", "loadbar"], [4, 4, 1, "", "log"], [4, 4, 1, "", "table"], [4, 4, 1, "", "time_stamp"], [4, 4, 1, "", "warn"]], "tcutility.log.Emojis": [[4, 2, 1, "", "angstrom"], [4, 2, 1, "", "cancel"], [4, 2, 1, "", "empty"], [4, 2, 1, "", "fail"], [4, 2, 1, "", "finish"], [4, 2, 1, "", "good"], [4, 2, 1, "", "info"], [4, 2, 1, "", "larrow"], [4, 2, 1, "", "lrarrow"], [4, 2, 1, "", "question"], [4, 2, 1, "", "rarrow"], [4, 2, 1, "", "receive"], [4, 2, 1, "", "rlarrow"], [4, 2, 1, "", "send"], [4, 2, 1, "", "sleep"], [4, 2, 1, "", "wait"], [4, 2, 1, "", "warning"]], "tcutility.molecule": [[4, 4, 1, "", "guess_fragments"], [4, 4, 1, "", "load"], [4, 4, 1, "", "parse_str"], [4, 4, 1, "", "save"]], "tcutility.report": [[4, 1, 1, "", "SI"]], "tcutility.report.SI": [[4, 3, 1, "", "add_heading"], [4, 3, 1, "", "add_xyz"]], "tcutility.results": [[13, 0, 0, "-", "adf"], [13, 0, 0, "-", "ams"], [13, 0, 0, "-", "cache"], [13, 0, 0, "-", "dftb"], [13, 4, 1, "", "get_info"], [13, 0, 0, "-", "orca"], [13, 4, 1, "", "read"], [13, 0, 0, "-", "result"]], "tcutility.results.adf": [[13, 4, 1, "", "get_calc_settings"], [13, 4, 1, "", "get_level_of_theory"], [13, 4, 1, "", "get_properties"]], "tcutility.results.ams": [[13, 4, 1, "", "get_ams_info"], [13, 4, 1, "", "get_ams_input"], [13, 4, 1, "", "get_ams_version"], [13, 4, 1, "", "get_calc_files"], [13, 4, 1, "", "get_calculation_status"], [13, 4, 1, "", "get_history"], [13, 4, 1, "", "get_input_blocks"], [13, 4, 1, "", "get_molecules"], [13, 4, 1, "", "get_timing"]], "tcutility.results.cache": [[13, 1, 1, "", "TrackKFReader"], [13, 4, 1, "", "get"], [13, 4, 1, "", "store"], [13, 4, 1, "", "unload"]], "tcutility.results.cache.TrackKFReader": [[13, 3, 1, "", "read"]], "tcutility.results.dftb": [[13, 4, 1, "", "get_calc_settings"], [13, 4, 1, "", "get_properties"]], "tcutility.results.orca": [[13, 4, 1, "", "get_calc_files"], [13, 4, 1, "", "get_calc_settings"], [13, 4, 1, "", "get_calculation_status"], [13, 4, 1, "", "get_info"], [13, 4, 1, "", "get_input"], [13, 4, 1, "", "get_level_of_theory"], [13, 4, 1, "", "get_molecules"], [13, 4, 1, "", "get_properties"], [13, 4, 1, "", "get_version"], [13, 4, 1, "", "get_vibrations"]], "tcutility.results.result": [[13, 1, 1, "", "Result"]], "tcutility.results.result.Result": [[13, 3, 1, "", "as_plams_settings"], [13, 3, 1, "", "get_multi_key"], [13, 3, 1, "", "get_parent_tree"], [13, 3, 1, "", "items"], [13, 3, 1, "", "keys"], [13, 3, 1, "", "prune"]], "tcutility.slurm": [[4, 4, 1, "", "has_slurm"], [4, 4, 1, "", "sbatch"], [4, 4, 1, "", "squeue"], [4, 4, 1, "", "wait_for_job"], [4, 4, 1, "", "workdir_info"]], "tcutility.spell_check": [[4, 4, 1, "", "check"], [4, 4, 1, "", "get_closest"], [4, 4, 1, "", "make_suggestion"], [4, 4, 1, "", "naive_recursive"], [4, 4, 1, "", "wagner_fischer"]], "tcutility.typing": [[14, 0, 0, "-", "arrays"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:function", "5": "py:property"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"], "5": ["py", "property", "Python property"]}, "titleterms": {"overview": [0, 18], "analysi": [0, 1, 2, 5, 6, 7], "modul": [0, 1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 16], "transit": 1, "state": 1, "vdd": [2, 6], "charg": [2, 6], "requir": [2, 18], "exampl": [2, 15, 18], "api": [2, 16], "tcutil": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "packag": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "subpackag": [4, 5, 9, 11], "submodul": [4, 6, 7, 9, 11, 12, 13, 14], "cach": [4, 13], "constant": [4, 17], "formula": 4, "geometri": 4, "log": 4, "molecul": [4, 9], "report": 4, "slurm": [4, 18], "content": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14], "manag": 6, "vibrat": 7, "ts_vibrat": 7, "atom_data_info": [8, 10], "job": [11, 12, 15, 18], "adf": [11, 13], "am": [11, 13], "crest": 11, "dftb": [11, 13], "gener": 11, "nmr": 11, "orca": [11, 13], "result": [13, 15], "type": 14, "arrai": 14, "v0": 16, "7": [], "2": [], "document": 16, "extra": 16, "util": 16, "ar": 16, "full": 16, "indic": 16, "tabl": 16, "setup": 18, "workflow": 18, "class": 18, "support": 18, "depend": 18, "engin": 18, "read": 19, "calcul": 19, "8": 16, "0": [], "spell_check": 4, "1": [], "3": [], "4": [], "5": 16, "postscript": 12, "clean_workdir": 12, "split_crest_xyz": 12, "write_converged_geom": 12, "data": [9, 10], "atom": 9, "basis_set": 9, "cosmo": 9, "function": 9}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Overview of the analysis module": [[0, "overview-of-the-analysis-module"]], "Transition State Analysis module": [[1, "transition-state-analysis-module"]], "VDD Charge Analysis module": [[2, "vdd-charge-analysis-module"]], "Requirements": [[2, "requirements"], [18, "requirements"]], "Example": [[2, "example"]], "VDD analysis API": [[2, "vdd-analysis-api"]], "tcutility": [[3, "tcutility"]], "tcutility package": [[4, "tcutility-package"], [15, "tcutility-package"]], "Subpackages": [[4, "subpackages"], [5, "subpackages"], [9, "subpackages"], [11, "subpackages"]], "Submodules": [[4, "submodules"], [6, "submodules"], [7, "submodules"], [9, "submodules"], [11, "submodules"], [12, "submodules"], [13, "submodules"], [14, "submodules"]], "tcutility.cache module": [[4, "module-tcutility.cache"]], "tcutility.constants module": [[4, "module-tcutility.constants"]], "tcutility.formula module": [[4, "module-tcutility.formula"]], "tcutility.geometry module": [[4, "module-tcutility.geometry"]], "tcutility.log module": [[4, "module-tcutility.log"]], "tcutility.molecule module": [[4, "module-tcutility.molecule"]], "tcutility.report module": [[4, "module-tcutility.report"]], "tcutility.slurm module": [[4, "module-tcutility.slurm"]], "tcutility.spell_check module": [[4, "module-tcutility.spell_check"]], "Module contents": [[4, "module-tcutility"], [5, "module-tcutility.analysis"], [6, "module-tcutility.analysis.vdd"], [7, "module-tcutility.analysis.vibration"], [8, "module-contents"], [9, "module-tcutility.data"], [10, "module-tcutility.data.atom_data_info"], [11, "module-tcutility.job"], [12, "module-tcutility.job.postscripts"], [13, "module-tcutility.results"], [14, "module-tcutility.typing"]], "tcutility.analysis package": [[5, "tcutility-analysis-package"]], "tcutility.analysis.vdd package": [[6, "tcutility-analysis-vdd-package"]], "tcutility.analysis.vdd.charge module": [[6, "module-tcutility.analysis.vdd.charge"]], "tcutility.analysis.vdd.manager module": [[6, "module-tcutility.analysis.vdd.manager"]], "tcutility.analysis.vibration package": [[7, "tcutility-analysis-vibration-package"]], "tcutility.analysis.vibration.ts_vibration module": [[7, "module-tcutility.analysis.vibration.ts_vibration"]], "tcutility.atom_data_info package": [[8, "tcutility-atom-data-info-package"]], "tcutility.data package": [[9, "tcutility-data-package"]], "tcutility.data.atom module": [[9, "module-tcutility.data.atom"]], "tcutility.data.basis_sets module": [[9, "module-tcutility.data.basis_sets"]], "tcutility.data.cosmo module": [[9, "module-tcutility.data.cosmo"]], "tcutility.data.functionals module": [[9, "module-tcutility.data.functionals"]], "tcutility.data.molecules module": [[9, "module-tcutility.data.molecules"]], "tcutility.data.atom_data_info package": [[10, "tcutility-data-atom-data-info-package"]], "tcutility.job package": [[11, "tcutility-job-package"], [15, "tcutility-job-package"]], "tcutility.job.adf module": [[11, "module-tcutility.job.adf"]], "tcutility.job.ams module": [[11, "module-tcutility.job.ams"]], "tcutility.job.crest module": [[11, "module-tcutility.job.crest"]], "tcutility.job.dftb module": [[11, "module-tcutility.job.dftb"]], "tcutility.job.generic module": [[11, "module-tcutility.job.generic"]], "tcutility.job.nmr module": [[11, "module-tcutility.job.nmr"]], "tcutility.job.orca module": [[11, "module-tcutility.job.orca"]], "tcutility.job.postscripts package": [[12, "tcutility-job-postscripts-package"]], "tcutility.job.postscripts.clean_workdir module": [[12, "module-tcutility.job.postscripts.clean_workdir"]], "tcutility.job.postscripts.split_crest_xyz module": [[12, "module-tcutility.job.postscripts.split_crest_xyz"]], "tcutility.job.postscripts.write_converged_geoms module": [[12, "module-tcutility.job.postscripts.write_converged_geoms"]], "tcutility.results package": [[13, "tcutility-results-package"], [15, "tcutility-results-package"]], "tcutility.results.adf module": [[13, "module-tcutility.results.adf"]], "tcutility.results.ams module": [[13, "module-tcutility.results.ams"]], "tcutility.results.cache module": [[13, "module-tcutility.results.cache"]], "tcutility.results.dftb module": [[13, "module-tcutility.results.dftb"]], "tcutility.results.orca module": [[13, "module-tcutility.results.orca"]], "tcutility.results.result module": [[13, "module-tcutility.results.result"]], "tcutility.typing package": [[14, "tcutility-typing-package"]], "tcutility.typing.arrays module": [[14, "module-tcutility.typing.arrays"]], "Examples": [[15, "examples"], [18, "examples"]], "TCutility v0.8.5 documentation": [[16, "tcutility-projectversion-documentation"]], "Extra (utility) modules are:": [[16, null]], "Full API:": [[16, null]], "Indices and tables": [[16, "indices-and-tables"]], "tcutility.constants package": [[17, "tcutility-constants-package"]], "Setup workflows with tcutility.job": [[18, "setup-workflows-with-tcutility-job"]], "Overview": [[18, "overview"]], "Job classes": [[18, "job-classes"]], "Slurm support": [[18, "slurm-support"]], "Job dependencies": [[18, "job-dependencies"]], "Supported engines": [[18, "supported-engines"]], "Reading a calculation": [[19, "reading-a-calculation"]]}, "indexentries": {"emojis (class in tcutility.log)": [[4, "tcutility.log.Emojis"]], "kabschtransform (class in tcutility.geometry)": [[4, "tcutility.geometry.KabschTransform"]], "noprint (class in tcutility.log)": [[4, "tcutility.log.NoPrint"]], "rmsd() (in module tcutility.geometry)": [[4, "tcutility.geometry.RMSD"]], "si (class in tcutility.report)": [[4, "tcutility.report.SI"]], "transform (class in tcutility.geometry)": [[4, "tcutility.geometry.Transform"]], "add_heading() (si method)": [[4, "tcutility.report.SI.add_heading"]], "add_xyz() (si method)": [[4, "tcutility.report.SI.add_xyz"]], "angstrom (emojis attribute)": [[4, "tcutility.log.Emojis.angstrom"]], "apply() (transform method)": [[4, "tcutility.geometry.Transform.apply"]], "apply_rotmat() (in module tcutility.geometry)": [[4, "tcutility.geometry.apply_rotmat"]], "boxed() (in module tcutility.log)": [[4, "tcutility.log.boxed"]], "cache() (in module tcutility.cache)": [[4, "tcutility.cache.cache"]], "caller_name() (in module tcutility.log)": [[4, "tcutility.log.caller_name"]], "cancel (emojis attribute)": [[4, "tcutility.log.Emojis.cancel"]], "check() (in module tcutility.spell_check)": [[4, "tcutility.spell_check.check"]], "combine_transforms() (transform method)": [[4, "tcutility.geometry.Transform.combine_transforms"]], "critical() (in module tcutility.log)": [[4, "tcutility.log.critical"]], "debug() (in module tcutility.log)": [[4, "tcutility.log.debug"]], "empty (emojis attribute)": [[4, "tcutility.log.Emojis.empty"]], "ensure_2d() (in module tcutility)": [[4, "tcutility.ensure_2d"]], "ensure_list() (in module tcutility)": [[4, "tcutility.ensure_list"]], "error() (in module tcutility.log)": [[4, "tcutility.log.error"]], "fail (emojis attribute)": [[4, "tcutility.log.Emojis.fail"]], "finish (emojis attribute)": [[4, "tcutility.log.Emojis.finish"]], "flow() (in module tcutility.log)": [[4, "tcutility.log.flow"]], "get_closest() (in module tcutility.spell_check)": [[4, "tcutility.spell_check.get_closest"]], "get_rotmat() (in module tcutility.geometry)": [[4, "tcutility.geometry.get_rotmat"]], "good (emojis attribute)": [[4, "tcutility.log.Emojis.good"]], "guess_fragments() (in module tcutility.molecule)": [[4, "tcutility.molecule.guess_fragments"]], "has_slurm() (in module tcutility.slurm)": [[4, "tcutility.slurm.has_slurm"]], "info (emojis attribute)": [[4, "tcutility.log.Emojis.info"]], "info() (in module tcutility.log)": [[4, "tcutility.log.info"]], "larrow (emojis attribute)": [[4, "tcutility.log.Emojis.larrow"]], "load() (in module tcutility.molecule)": [[4, "tcutility.molecule.load"]], "loadbar() (in module tcutility.log)": [[4, "tcutility.log.loadbar"]], "log() (in module tcutility.log)": [[4, "tcutility.log.log"]], "lrarrow (emojis attribute)": [[4, "tcutility.log.Emojis.lrarrow"]], "make_suggestion() (in module tcutility.spell_check)": [[4, "tcutility.spell_check.make_suggestion"]], "module": [[4, "module-tcutility"], [4, "module-tcutility.cache"], [4, "module-tcutility.constants"], [4, "module-tcutility.formula"], [4, "module-tcutility.geometry"], [4, "module-tcutility.log"], [4, "module-tcutility.molecule"], [4, "module-tcutility.report"], [4, "module-tcutility.slurm"], [4, "module-tcutility.spell_check"], [5, "module-tcutility.analysis"], [6, "module-tcutility.analysis.vdd"], [6, "module-tcutility.analysis.vdd.charge"], [6, "module-tcutility.analysis.vdd.manager"], [7, "module-tcutility.analysis.vibration"], [7, "module-tcutility.analysis.vibration.ts_vibration"], [9, "module-tcutility.data"], [9, "module-tcutility.data.atom"], [9, "module-tcutility.data.basis_sets"], [9, "module-tcutility.data.cosmo"], [9, "module-tcutility.data.functionals"], [9, "module-tcutility.data.molecules"], [10, "module-tcutility.data.atom_data_info"], [11, "module-tcutility.job"], [11, "module-tcutility.job.adf"], [11, "module-tcutility.job.ams"], [11, "module-tcutility.job.crest"], [11, "module-tcutility.job.dftb"], [11, "module-tcutility.job.generic"], [11, "module-tcutility.job.nmr"], [11, "module-tcutility.job.orca"], [12, "module-tcutility.job.postscripts"], [12, "module-tcutility.job.postscripts.clean_workdir"], [12, "module-tcutility.job.postscripts.split_crest_xyz"], [12, "module-tcutility.job.postscripts.write_converged_geoms"], [13, "module-tcutility.results"], [13, "module-tcutility.results.adf"], [13, "module-tcutility.results.ams"], [13, "module-tcutility.results.cache"], [13, "module-tcutility.results.dftb"], [13, "module-tcutility.results.orca"], [13, "module-tcutility.results.result"], [14, "module-tcutility.typing"], [14, "module-tcutility.typing.arrays"]], "molecule() (in module tcutility.formula)": [[4, "tcutility.formula.molecule"]], "naive_recursive() (in module tcutility.spell_check)": [[4, "tcutility.spell_check.naive_recursive"]], "parse_molecule() (in module tcutility.formula)": [[4, "tcutility.formula.parse_molecule"]], "parse_str() (in module tcutility.molecule)": [[4, "tcutility.molecule.parse_str"]], "question (emojis attribute)": [[4, "tcutility.log.Emojis.question"]], "random_points_in_anular_sphere() (in module tcutility.geometry)": [[4, "tcutility.geometry.random_points_in_anular_sphere"]], "random_points_on_sphere() (in module tcutility.geometry)": [[4, "tcutility.geometry.random_points_on_sphere"]], "rarrow (emojis attribute)": [[4, "tcutility.log.Emojis.rarrow"]], "receive (emojis attribute)": [[4, "tcutility.log.Emojis.receive"]], "rlarrow (emojis attribute)": [[4, "tcutility.log.Emojis.rlarrow"]], "rotate() (transform method)": [[4, "tcutility.geometry.Transform.rotate"]], "rotate() (in module tcutility.geometry)": [[4, "tcutility.geometry.rotate"]], "save() (in module tcutility.molecule)": [[4, "tcutility.molecule.save"]], "sbatch() (in module tcutility.slurm)": [[4, "tcutility.slurm.sbatch"]], "scale() (transform method)": [[4, "tcutility.geometry.Transform.scale"]], "send (emojis attribute)": [[4, "tcutility.log.Emojis.send"]], "sleep (emojis attribute)": [[4, "tcutility.log.Emojis.sleep"]], "squeeze_list() (in module tcutility)": [[4, "tcutility.squeeze_list"]], "squeue() (in module tcutility.slurm)": [[4, "tcutility.slurm.squeue"]], "table() (in module tcutility.log)": [[4, "tcutility.log.table"]], "tcutility": [[4, "module-tcutility"]], "tcutility.cache": [[4, "module-tcutility.cache"]], "tcutility.constants": [[4, "module-tcutility.constants"]], "tcutility.formula": [[4, "module-tcutility.formula"]], "tcutility.geometry": [[4, "module-tcutility.geometry"]], "tcutility.log": [[4, "module-tcutility.log"]], "tcutility.molecule": [[4, "module-tcutility.molecule"]], "tcutility.report": [[4, "module-tcutility.report"]], "tcutility.slurm": [[4, "module-tcutility.slurm"]], "tcutility.spell_check": [[4, "module-tcutility.spell_check"]], "time_stamp() (in module tcutility.log)": [[4, "tcutility.log.time_stamp"]], "timed_cache() (in module tcutility.cache)": [[4, "tcutility.cache.timed_cache"]], "translate() (transform method)": [[4, "tcutility.geometry.Transform.translate"]], "vector_align_rotmat() (in module tcutility.geometry)": [[4, "tcutility.geometry.vector_align_rotmat"]], "wagner_fischer() (in module tcutility.spell_check)": [[4, "tcutility.spell_check.wagner_fischer"]], "wait (emojis attribute)": [[4, "tcutility.log.Emojis.wait"]], "wait_for_job() (in module tcutility.slurm)": [[4, "tcutility.slurm.wait_for_job"]], "warn() (in module tcutility.log)": [[4, "tcutility.log.warn"]], "warning (emojis attribute)": [[4, "tcutility.log.Emojis.warning"]], "workdir_info() (in module tcutility.slurm)": [[4, "tcutility.slurm.workdir_info"]], "tcutility.analysis": [[5, "module-tcutility.analysis"]], "vddcharge (class in tcutility.analysis.vdd.charge)": [[6, "tcutility.analysis.vdd.charge.VDDCharge"]], "vddchargemanager (class in tcutility.analysis.vdd.manager)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager"]], "atom_index (vddcharge attribute)": [[6, "tcutility.analysis.vdd.charge.VDDCharge.atom_index"]], "atom_symbol (vddcharge attribute)": [[6, "tcutility.analysis.vdd.charge.VDDCharge.atom_symbol"]], "calc_dir (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.calc_dir"]], "change_unit() (vddcharge method)": [[6, "tcutility.analysis.vdd.charge.VDDCharge.change_unit"]], "change_unit() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.change_unit"]], "change_unit_decorator() (in module tcutility.analysis.vdd.manager)": [[6, "tcutility.analysis.vdd.manager.change_unit_decorator"]], "charge (vddcharge attribute)": [[6, "tcutility.analysis.vdd.charge.VDDCharge.charge"]], "charge_is_conserved() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.charge_is_conserved"]], "create_vdd_charge_manager() (in module tcutility.analysis.vdd.manager)": [[6, "tcutility.analysis.vdd.manager.create_vdd_charge_manager"]], "frag_index (vddcharge attribute)": [[6, "tcutility.analysis.vdd.charge.VDDCharge.frag_index"]], "get_summed_vdd_charges() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_summed_vdd_charges"]], "get_summed_vdd_charges_dataframe() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_summed_vdd_charges_dataframe"]], "get_summed_vdd_charges_table() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_summed_vdd_charges_table"]], "get_vdd_charges() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_vdd_charges"]], "get_vdd_charges_dataframe() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_vdd_charges_dataframe"]], "get_vdd_charges_table() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.get_vdd_charges_table"]], "irreps (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.irreps"]], "is_fragment_calculation (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.is_fragment_calculation"]], "mol_charge (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.mol_charge"]], "name (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.name"]], "plot_vdd_charges_per_atom() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.plot_vdd_charges_per_atom"]], "tcutility.analysis.vdd": [[6, "module-tcutility.analysis.vdd"]], "tcutility.analysis.vdd.charge": [[6, "module-tcutility.analysis.vdd.charge"]], "tcutility.analysis.vdd.manager": [[6, "module-tcutility.analysis.vdd.manager"]], "unit (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.unit"]], "vdd_charges (vddchargemanager attribute)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.vdd_charges"]], "write_to_excel() (vddchargemanager method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.write_to_excel"]], "write_to_txt() (vddchargemanager static method)": [[6, "tcutility.analysis.vdd.manager.VDDChargeManager.write_to_txt"]], "avg_relative_bond_length_delta() (in module tcutility.analysis.vibration.ts_vibration)": [[7, "tcutility.analysis.vibration.ts_vibration.avg_relative_bond_length_delta"]], "determine_ts_reactioncoordinate() (in module tcutility.analysis.vibration.ts_vibration)": [[7, "tcutility.analysis.vibration.ts_vibration.determine_ts_reactioncoordinate"]], "tcutility.analysis.vibration": [[7, "module-tcutility.analysis.vibration"]], "tcutility.analysis.vibration.ts_vibration": [[7, "module-tcutility.analysis.vibration.ts_vibration"]], "validate_transitionstate() (in module tcutility.analysis.vibration.ts_vibration)": [[7, "tcutility.analysis.vibration.ts_vibration.validate_transitionstate"]], "color() (in module tcutility.data.atom)": [[9, "tcutility.data.atom.color"]], "functional_name_from_path_safe_name() (in module tcutility.data.functionals)": [[9, "tcutility.data.functionals.functional_name_from_path_safe_name"]], "get() (in module tcutility.data.functionals)": [[9, "tcutility.data.functionals.get"]], "get() (in module tcutility.data.molecules)": [[9, "tcutility.data.molecules.get"]], "get_available_functionals() (in module tcutility.data.functionals)": [[9, "tcutility.data.functionals.get_available_functionals"]], "get_molecules() (in module tcutility.data.molecules)": [[9, "tcutility.data.molecules.get_molecules"]], "parse_element() (in module tcutility.data.atom)": [[9, "tcutility.data.atom.parse_element"]], "radius() (in module tcutility.data.atom)": [[9, "tcutility.data.atom.radius"]], "tcutility.data": [[9, "module-tcutility.data"]], "tcutility.data.atom": [[9, "module-tcutility.data.atom"]], "tcutility.data.basis_sets": [[9, "module-tcutility.data.basis_sets"]], "tcutility.data.cosmo": [[9, "module-tcutility.data.cosmo"]], "tcutility.data.functionals": [[9, "module-tcutility.data.functionals"]], "tcutility.data.molecules": [[9, "module-tcutility.data.molecules"]], "tcutility.data.atom_data_info": [[10, "module-tcutility.data.atom_data_info"]], "adffragmentjob (class in tcutility.job.adf)": [[11, "tcutility.job.adf.ADFFragmentJob"]], "adfjob (class in tcutility.job.adf)": [[11, "tcutility.job.adf.ADFJob"]], "amsjob (class in tcutility.job.ams)": [[11, "tcutility.job.ams.AMSJob"]], "crestjob (class in tcutility.job.crest)": [[11, "tcutility.job.crest.CRESTJob"]], "dftbjob (class in tcutility.job.dftb)": [[11, "tcutility.job.dftb.DFTBJob"]], "irc() (amsjob method)": [[11, "tcutility.job.ams.AMSJob.IRC"]], "job (class in tcutility.job.generic)": [[11, "tcutility.job.generic.Job"]], "nmrjob (class in tcutility.job.nmr)": [[11, "tcutility.job.nmr.NMRJob"]], "orcajob (class in tcutility.job.orca)": [[11, "tcutility.job.orca.ORCAJob"]], "qcgjob (class in tcutility.job.crest)": [[11, "tcutility.job.crest.QCGJob"]], "scf_convergence() (adfjob method)": [[11, "tcutility.job.adf.ADFJob.SCF_convergence"]], "add_fragment() (adffragmentjob method)": [[11, "tcutility.job.adf.ADFFragmentJob.add_fragment"]], "add_nics_point() (nmrjob method)": [[11, "tcutility.job.nmr.NMRJob.add_nics_point"]], "add_postamble() (job method)": [[11, "tcutility.job.generic.Job.add_postamble"]], "add_postscript() (job method)": [[11, "tcutility.job.generic.Job.add_postscript"]], "add_preamble() (job method)": [[11, "tcutility.job.generic.Job.add_preamble"]], "alpb() (qcgjob method)": [[11, "tcutility.job.crest.QCGJob.alpb"]], "basis_set() (adfjob method)": [[11, "tcutility.job.adf.ADFJob.basis_set"]], "best_conformer_path (crestjob property)": [[11, "tcutility.job.crest.CRESTJob.best_conformer_path"]], "best_ensemble_path (qcgjob property)": [[11, "tcutility.job.crest.QCGJob.best_ensemble_path"]], "can_skip() (job method)": [[11, "tcutility.job.generic.Job.can_skip"]], "charge() (amsjob method)": [[11, "tcutility.job.ams.AMSJob.charge"]], "charge() (crestjob method)": [[11, "tcutility.job.crest.CRESTJob.charge"]], "charge() (orcajob method)": [[11, "tcutility.job.orca.ORCAJob.charge"]], "conformer_directory (crestjob property)": [[11, "tcutility.job.crest.CRESTJob.conformer_directory"]], "dependency() (job method)": [[11, "tcutility.job.generic.Job.dependency"]], "ensemble_directory (qcgjob property)": [[11, "tcutility.job.crest.QCGJob.ensemble_directory"]], "ensemble_mode() (qcgjob method)": [[11, "tcutility.job.crest.QCGJob.ensemble_mode"]], "functional() (adfjob method)": [[11, "tcutility.job.adf.ADFJob.functional"]], "geometry_convergence() (amsjob method)": [[11, "tcutility.job.ams.AMSJob.geometry_convergence"]], "get_conformer_xyz() (crestjob method)": [[11, "tcutility.job.crest.CRESTJob.get_conformer_xyz"]], "get_ensemble_xyz() (qcgjob method)": [[11, "tcutility.job.crest.QCGJob.get_ensemble_xyz"]], "get_input() (orcajob method)": [[11, "tcutility.job.orca.ORCAJob.get_input"]], "get_memory_usage() (orcajob method)": [[11, "tcutility.job.orca.ORCAJob.get_memory_usage"]], "get_rotamer_xyz() (crestjob method)": [[11, "tcutility.job.crest.CRESTJob.get_rotamer_xyz"]], "inputfile_path (job property)": [[11, "tcutility.job.generic.Job.inputfile_path"]], "kspace() (dftbjob method)": [[11, "tcutility.job.dftb.DFTBJob.kspace"]], "md_length() (crestjob method)": [[11, "tcutility.job.crest.CRESTJob.md_length"]], "md_temperature() (crestjob method)": [[11, "tcutility.job.crest.CRESTJob.md_temperature"]], "model() (dftbjob method)": [[11, "tcutility.job.dftb.DFTBJob.model"]], "molecule() (job method)": [[11, "tcutility.job.generic.Job.molecule"]], "multiplicity() (adfjob method)": [[11, "tcutility.job.adf.ADFJob.multiplicity"]], "multiplicity() (crestjob method)": [[11, "tcutility.job.crest.CRESTJob.multiplicity"]], "multiplicity() (orcajob method)": [[11, "tcutility.job.orca.ORCAJob.multiplicity"]], "nofix() (qcgjob method)": [[11, "tcutility.job.crest.QCGJob.nofix"]], "nsolv() (qcgjob method)": [[11, "tcutility.job.crest.QCGJob.nsolv"]], "optimization() (amsjob method)": [[11, "tcutility.job.ams.AMSJob.optimization"]], "optimization() (orcajob method)": [[11, "tcutility.job.orca.ORCAJob.optimization"]], "output_mol_path (amsjob property)": [[11, "tcutility.job.ams.AMSJob.output_mol_path"]], "output_mol_path (job property)": [[11, "tcutility.job.generic.Job.output_mol_path"]], "quality() (adfjob method)": [[11, "tcutility.job.adf.ADFJob.quality"]], "relativity() (adfjob method)": [[11, "tcutility.job.adf.ADFJob.relativity"]], "rotamer_directory (crestjob property)": [[11, "tcutility.job.crest.CRESTJob.rotamer_directory"]], "run() (adffragmentjob method)": [[11, "tcutility.job.adf.ADFFragmentJob.run"]], "run() (job method)": [[11, "tcutility.job.generic.Job.run"]], "runfile_path (job property)": [[11, "tcutility.job.generic.Job.runfile_path"]], "sbatch() (job method)": [[11, "tcutility.job.generic.Job.sbatch"]], "single_point() (amsjob method)": [[11, "tcutility.job.ams.AMSJob.single_point"]], "single_point() (orcajob method)": [[11, "tcutility.job.orca.ORCAJob.single_point"]], "solvent() (adfjob method)": [[11, "tcutility.job.adf.ADFJob.solvent"]], "solvent() (dftbjob method)": [[11, "tcutility.job.dftb.DFTBJob.solvent"]], "solvent() (qcgjob method)": [[11, "tcutility.job.crest.QCGJob.solvent"]], "spin_polarization() (adfjob method)": [[11, "tcutility.job.adf.ADFJob.spin_polarization"]], "spin_polarization() (crestjob method)": [[11, "tcutility.job.crest.CRESTJob.spin_polarization"]], "spin_polarization() (orcajob method)": [[11, "tcutility.job.orca.ORCAJob.spin_polarization"]], "tcutility.job": [[11, "module-tcutility.job"]], "tcutility.job.adf": [[11, "module-tcutility.job.adf"]], "tcutility.job.ams": [[11, "module-tcutility.job.ams"]], "tcutility.job.crest": [[11, "module-tcutility.job.crest"]], "tcutility.job.dftb": [[11, "module-tcutility.job.dftb"]], "tcutility.job.generic": [[11, "module-tcutility.job.generic"]], "tcutility.job.nmr": [[11, "module-tcutility.job.nmr"]], "tcutility.job.orca": [[11, "module-tcutility.job.orca"]], "transition_state() (amsjob method)": [[11, "tcutility.job.ams.AMSJob.transition_state"]], "transition_state() (orcajob method)": [[11, "tcutility.job.orca.ORCAJob.transition_state"]], "unrestricted() (adfjob method)": [[11, "tcutility.job.adf.ADFJob.unrestricted"]], "vibrations() (amsjob method)": [[11, "tcutility.job.ams.AMSJob.vibrations"]], "vibrations() (orcajob method)": [[11, "tcutility.job.orca.ORCAJob.vibrations"]], "workdir (job property)": [[11, "tcutility.job.generic.Job.workdir"]], "tcutility.job.postscripts": [[12, "module-tcutility.job.postscripts"]], "tcutility.job.postscripts.clean_workdir": [[12, "module-tcutility.job.postscripts.clean_workdir"]], "tcutility.job.postscripts.split_crest_xyz": [[12, "module-tcutility.job.postscripts.split_crest_xyz"]], "tcutility.job.postscripts.write_converged_geoms": [[12, "module-tcutility.job.postscripts.write_converged_geoms"]], "result (class in tcutility.results.result)": [[13, "tcutility.results.result.Result"]], "trackkfreader (class in tcutility.results.cache)": [[13, "tcutility.results.cache.TrackKFReader"]], "as_plams_settings() (result method)": [[13, "tcutility.results.result.Result.as_plams_settings"]], "get() (in module tcutility.results.cache)": [[13, "tcutility.results.cache.get"]], "get_ams_info() (in module tcutility.results.ams)": [[13, "tcutility.results.ams.get_ams_info"]], "get_ams_input() (in module tcutility.results.ams)": [[13, "tcutility.results.ams.get_ams_input"]], "get_ams_version() (in module tcutility.results.ams)": [[13, "tcutility.results.ams.get_ams_version"]], "get_calc_files() (in module tcutility.results.ams)": [[13, "tcutility.results.ams.get_calc_files"]], "get_calc_files() (in module tcutility.results.orca)": [[13, "tcutility.results.orca.get_calc_files"]], "get_calc_settings() (in module tcutility.results.adf)": [[13, "tcutility.results.adf.get_calc_settings"]], "get_calc_settings() (in module tcutility.results.dftb)": [[13, "tcutility.results.dftb.get_calc_settings"]], "get_calc_settings() (in module tcutility.results.orca)": [[13, "tcutility.results.orca.get_calc_settings"]], "get_calculation_status() (in module tcutility.results.ams)": [[13, "tcutility.results.ams.get_calculation_status"]], "get_calculation_status() (in module tcutility.results.orca)": [[13, "tcutility.results.orca.get_calculation_status"]], "get_history() (in module tcutility.results.ams)": [[13, "tcutility.results.ams.get_history"]], "get_info() (in module tcutility.results)": [[13, "tcutility.results.get_info"]], "get_info() (in module tcutility.results.orca)": [[13, "tcutility.results.orca.get_info"]], "get_input() (in module tcutility.results.orca)": [[13, "tcutility.results.orca.get_input"]], "get_input_blocks() (in module tcutility.results.ams)": [[13, "tcutility.results.ams.get_input_blocks"]], "get_level_of_theory() (in module tcutility.results.adf)": [[13, "tcutility.results.adf.get_level_of_theory"]], "get_level_of_theory() (in module tcutility.results.orca)": [[13, "tcutility.results.orca.get_level_of_theory"]], "get_molecules() (in module tcutility.results.ams)": [[13, "tcutility.results.ams.get_molecules"]], "get_molecules() (in module tcutility.results.orca)": [[13, "tcutility.results.orca.get_molecules"]], "get_multi_key() (result method)": [[13, "tcutility.results.result.Result.get_multi_key"]], "get_parent_tree() (result method)": [[13, "tcutility.results.result.Result.get_parent_tree"]], "get_properties() (in module tcutility.results.adf)": [[13, "tcutility.results.adf.get_properties"]], "get_properties() (in module tcutility.results.dftb)": [[13, "tcutility.results.dftb.get_properties"]], "get_properties() (in module tcutility.results.orca)": [[13, "tcutility.results.orca.get_properties"]], "get_timing() (in module tcutility.results.ams)": [[13, "tcutility.results.ams.get_timing"]], "get_version() (in module tcutility.results.orca)": [[13, "tcutility.results.orca.get_version"]], "get_vibrations() (in module tcutility.results.orca)": [[13, "tcutility.results.orca.get_vibrations"]], "items() (result method)": [[13, "tcutility.results.result.Result.items"]], "keys() (result method)": [[13, "tcutility.results.result.Result.keys"]], "prune() (result method)": [[13, "tcutility.results.result.Result.prune"]], "read() (trackkfreader method)": [[13, "tcutility.results.cache.TrackKFReader.read"]], "read() (in module tcutility.results)": [[13, "tcutility.results.read"]], "store() (in module tcutility.results.cache)": [[13, "tcutility.results.cache.store"]], "tcutility.results": [[13, "module-tcutility.results"]], "tcutility.results.adf": [[13, "module-tcutility.results.adf"]], "tcutility.results.ams": [[13, "module-tcutility.results.ams"]], "tcutility.results.cache": [[13, "module-tcutility.results.cache"]], "tcutility.results.dftb": [[13, "module-tcutility.results.dftb"]], "tcutility.results.orca": [[13, "module-tcutility.results.orca"]], "tcutility.results.result": [[13, "module-tcutility.results.result"]], "unload() (in module tcutility.results.cache)": [[13, "tcutility.results.cache.unload"]], "tcutility.typing": [[14, "module-tcutility.typing"]], "tcutility.typing.arrays": [[14, "module-tcutility.typing.arrays"]]}}) \ No newline at end of file diff --git a/docs/api/tcutility.data.atom_data_info.rst b/docs/api/tcutility.data.atom_data_info.rst new file mode 100644 index 00000000..7b4c05e9 --- /dev/null +++ b/docs/api/tcutility.data.atom_data_info.rst @@ -0,0 +1,10 @@ +tcutility.data.atom\_data\_info package +======================================= + +Module contents +--------------- + +.. automodule:: tcutility.data.atom_data_info + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/tcutility.data.rst b/docs/api/tcutility.data.rst new file mode 100644 index 00000000..44b0121c --- /dev/null +++ b/docs/api/tcutility.data.rst @@ -0,0 +1,61 @@ +tcutility.data package +====================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + tcutility.data.atom_data_info + +Submodules +---------- + +tcutility.data.atom module +-------------------------- + +.. automodule:: tcutility.data.atom + :members: + :undoc-members: + :show-inheritance: + +tcutility.data.basis\_sets module +--------------------------------- + +.. automodule:: tcutility.data.basis_sets + :members: + :undoc-members: + :show-inheritance: + +tcutility.data.cosmo module +--------------------------- + +.. automodule:: tcutility.data.cosmo + :members: + :undoc-members: + :show-inheritance: + +tcutility.data.functionals module +--------------------------------- + +.. automodule:: tcutility.data.functionals + :members: + :undoc-members: + :show-inheritance: + +tcutility.data.molecules module +------------------------------- + +.. automodule:: tcutility.data.molecules + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tcutility.data + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/tcutility.rst b/docs/api/tcutility.rst index 4b98ca3c..3654fd72 100644 --- a/docs/api/tcutility.rst +++ b/docs/api/tcutility.rst @@ -8,6 +8,7 @@ Subpackages :maxdepth: 4 tcutility.analysis + tcutility.data tcutility.job tcutility.results tcutility.typing