Skip to content

Commit

Permalink
add thing
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasturcani committed Apr 25, 2024
1 parent 339dbbc commit f42060b
Showing 1 changed file with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions src/stko/_internal/calculators/rdkit_calculators.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
from collections import abc

import stk
from rdkit.Chem import AllChem as rdkit
from rdkit.Chem import AllChem as rdkit # noqa: N813

from stko._internal.calculators.results.energy_results import EnergyResults

logger = logging.getLogger(__name__)
Expand All @@ -12,7 +13,6 @@ class MMFFEnergy:
"""Uses the MMFF force field to calculate energies.
Examples:
--------
.. code-block:: python
import stk
Expand Down Expand Up @@ -49,13 +49,11 @@ def calculate(self, mol: stk.Molecule) -> abc.Iterable[float]:
def get_results(self, mol: stk.Molecule) -> EnergyResults:
"""Calculate the energy of `mol`.
Parameters
----------
Parameters:
mol:
The :class:`stk.Molecule` whose energy is to be calculated.
Returns:
-------
The energy and units of the energy.
"""
Expand All @@ -67,13 +65,11 @@ def get_results(self, mol: stk.Molecule) -> EnergyResults:
def get_energy(self, mol: stk.Molecule) -> float:
"""Calculate the energy of `mol`.
Parameters
----------
Parameters:
mol:
The :class:`stk.Molecule` whose energy is to be calculated.
Returns:
-------
The energy.
"""
Expand All @@ -84,7 +80,6 @@ class UFFEnergy:
"""Uses the UFF force field to calculate energies.
Examples:
--------
.. code-block:: python
import stk
Expand Down Expand Up @@ -122,13 +117,11 @@ def calculate(self, mol: stk.Molecule) -> abc.Iterable[float]:
def get_results(self, mol: stk.Molecule) -> EnergyResults:
"""Calculate the energy of `mol`.
Parameters
----------
Parameters:
mol:
The :class:`stk.Molecule` whose energy is to be calculated.
Returns:
-------
The energy and units of the energy.
"""
Expand All @@ -140,13 +133,11 @@ def get_results(self, mol: stk.Molecule) -> EnergyResults:
def get_energy(self, mol: stk.Molecule) -> float:
"""Calculate the energy of `mol`.
Parameters
----------
Parameters:
mol:
The :class:`stk.Molecule` whose energy is to be calculated.
Returns:
-------
The energy.
"""
Expand Down

0 comments on commit f42060b

Please sign in to comment.