Skip to content

Commit

Permalink
Added supported_calctypes to the documentation for Adapters.
Browse files Browse the repository at this point in the history
  • Loading branch information
coltonbh committed Oct 3, 2024
1 parent c6625fe commit 42ca3b5
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 0 deletions.
1 change: 1 addition & 0 deletions qcop/adapters/crest.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ class CRESTAdapter(
CalcType.optimization,
CalcType.conformer_search,
]
"""Supported calculation types."""
program = "crest"

def program_version(self, stdout: Optional[str] = None) -> str:
Expand Down
1 change: 1 addition & 0 deletions qcop/adapters/geometric.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ class GeometricAdapter(ProgramAdapter[DualProgramInput, OptimizationResults]):

program = "geometric"
supported_calctypes = [CalcType.optimization, CalcType.transition_state]
"""Supported calculation types."""

def __init__(self):
super().__init__()
Expand Down
1 change: 1 addition & 0 deletions qcop/adapters/qcengine.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ class QCEngineAdapter(ProgramAdapter):

program = "qcengine"
supported_calctypes = [CalcType.energy, CalcType.gradient, CalcType.hessian]
"""Supported calculation types."""

def __init__(self, external_program: str) -> None:
super().__init__()
Expand Down
1 change: 1 addition & 0 deletions qcop/adapters/terachem.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ class TeraChemAdapter(ProgramAdapter[ProgramInput, SinglePointResults]):
CalcType.hessian,
CalcType.optimization,
]
"""Supported calculation types."""
program = "terachem"

def program_version(self, stdout: Optional[str] = None) -> str:
Expand Down
1 change: 1 addition & 0 deletions qcop/adapters/terachem_fe.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ class TeraChemFEAdapter(ProgramAdapter[ProgramInput, SinglePointResults]):
"""Adapter for TeraChem's Protocol Buffer Server and Frontend file server."""

supported_calctypes = [CalcType.energy, CalcType.gradient]
"""Supported calculation types."""
program = "terachem-fe"

def __init__(self):
Expand Down
1 change: 1 addition & 0 deletions qcop/adapters/xtb.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ class XTBAdapter(ProgramAdapter[ProgramInput, SinglePointResults]):
"""Adapter for xtb-python."""

supported_calctypes = [CalcType.energy, CalcType.gradient]
"""Supported calculation types."""
program = "xtb"
uses_files = False # xtb-python does not use files written to disk

Expand Down

0 comments on commit 42ca3b5

Please sign in to comment.