Skip to content

Commit

Permalink
Add docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew-S-Rosen committed Jan 14, 2024
1 parent 1d0a3a8 commit d71a8b1
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion src/raspa_ase/calculator.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,30 @@ def __init__(self, binary: Path | str | None = None, **kwargs) -> None:
self.binary = binary

def get_calculator_command(self, inputfile: str = SIMULATION_INPUT) -> list[str]:
"""
Construct the command for the calculator.
Parameters
----------
inputfile
The name of the input file to use.
Returns
-------
list[str]
The command to run the calculator.
"""
return [self.binary, f"{inputfile}"]

def version(self):
def version(self) -> str:
"""
Get the RASPA version number.
Returns
------
str
The RASPA version.
"""
raise NotImplementedError


Expand Down

0 comments on commit d71a8b1

Please sign in to comment.