Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Jacob Wilkins <[email protected]>
  • Loading branch information
alinelena and oerc0122 authored Sep 13, 2024
1 parent b8a45b9 commit 0f950d3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
18 changes: 9 additions & 9 deletions janus_core/calculations/phonons.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class Phonons(BaseCalculation):
Size of supercell for calculation. Default is 2.
displacement : float
Displacement for force constants calculation, in A. Default is 0.01.
mesh : MaybeSequence[float]
mesh : MaybeSequence[int]
Mesh for sampling. Default is (10, 10, 10).
symmetrize : bool
Whether to symmetrize force constants after calculation.
Expand Down Expand Up @@ -140,7 +140,7 @@ def __init__(
calcs: MaybeSequence[PhononCalcs] = (),
supercell: MaybeList[int] = 2,
displacement: float = 0.01,
mesh: MaybeSequence[float] = (10, 10, 10),
mesh: MaybeSequence[int] = (10, 10, 10),
symmetrize: bool = False,
minimize: bool = False,
minimize_kwargs: Optional[dict[str, Any]] = None,
Expand Down Expand Up @@ -189,7 +189,7 @@ def __init__(
Size of supercell for calculation. Default is 2.
displacement : float
Displacement for force constants calculation, in A. Default is 0.01.
mesh : MaybeSequence[float]
mesh : MaybeSequence[int]
Mesh for sampling. Default is (10, 10, 10).
symmetrize : bool
Whether to symmetrize force constants after calculations.
Expand Down Expand Up @@ -497,7 +497,7 @@ def write_bands(

def calc_thermal_props(
self,
mesh: Optional[MaybeSequence[float]] = None,
mesh: Optional[MaybeSequence[int]] = None,
write_thermal: Optional[bool] = None,
**kwargs,
) -> None:
Expand All @@ -506,7 +506,7 @@ def calc_thermal_props(
Parameters
----------
mesh : Optional[MaybeSequence[float]]
mesh : Optional[MaybeSequence[int]]
Mesh for sampling. Default is self.mesh.
write_thermal : Optional[bool]
Whether to write out thermal properties to file. Default is
Expand Down Expand Up @@ -577,7 +577,7 @@ def write_thermal_props(self, thermal_file: Optional[PathLike] = None) -> None:
def calc_dos(
self,
*,
mesh: Optional[MaybeSequence[float]] = None,
mesh: Optional[MaybeSequence[int]] = None,
write_dos: Optional[bool] = None,
**kwargs,
) -> None:
Expand All @@ -586,7 +586,7 @@ def calc_dos(
Parameters
----------
mesh : Optional[MaybeSequence[float]]
mesh : Optional[MaybeSequence[int]]
Mesh for sampling. Default is self.mesh.
write_dos : Optional[bool]
Whether to write out results to file. Default is True.
Expand Down Expand Up @@ -682,7 +682,7 @@ def write_dos(
def calc_pdos(
self,
*,
mesh: Optional[MaybeSequence[float]] = None,
mesh: Optional[MaybeSequence[int]] = None,
write_pdos: Optional[bool] = None,
**kwargs,
) -> None:
Expand All @@ -691,7 +691,7 @@ def calc_pdos(
Parameters
----------
mesh : Optional[MaybeSequence[float]]
mesh : Optional[MaybeSequence[int]]
Mesh for sampling. Default is self.mesh.
write_pdos : Optional[bool]
Whether to write out results to file. Default is self.write_results.
Expand Down
4 changes: 2 additions & 2 deletions janus_core/cli/phonons.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def phonons(
float, Option(help="Displacement for force constants calculation, in A.")
] = 0.01,
mesh: Annotated[
tuple[float, float, float], Option(help="Mesh numbers along a, b, c axes.")
tuple[int, int, int], Option(help="Mesh numbers along a, b, c axes.")
] = (10, 10, 10),
bands: Annotated[
bool,
Expand Down Expand Up @@ -127,7 +127,7 @@ def phonons(
2x2x2.
displacement : float
Displacement for force constants calculation, in A. Default is 0.01.
mesh : tuple[float, float, float]
mesh : tuple[int, int, int]
Mesh for sampling. Default is (10, 10, 10).
bands : bool
Whether to calculate and save the band structure. Default is False.
Expand Down

0 comments on commit 0f950d3

Please sign in to comment.