Skip to content

Commit

Permalink
one
Browse files Browse the repository at this point in the history
  • Loading branch information
alinelena committed Mar 4, 2024
1 parent 540a6e0 commit 4a42aad
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
5 changes: 1 addition & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,10 +183,7 @@

# Warnings to ignore when using the -n (nitpicky) option
# We should ignore any python built-in exception, for instance
nitpick_ignore = [
("py:class", "Logger"),
("py:class", "numpy.float64")
]
nitpick_ignore = [("py:class", "Logger"), ("py:class", "numpy.float64")]


def run_apidoc(_):
Expand Down
15 changes: 8 additions & 7 deletions janus_core/janus_types.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
"""
Module containing types used in Janus-Core
Module containing types used in Janus-Core.
"""

from collections.abc import Sequence
from pathlib import Path, PurePath
from typing import IO, Literal, Optional, Sequence, TypedDict, TypeVar, Union
from typing import IO, Literal, Optional, TypedDict, TypeVar, Union

from ase import Atoms
import numpy as np
Expand All @@ -21,7 +22,7 @@


class ASEReadArgs(TypedDict, total=False):
"""Main arguments for ase.io.read"""
"""Main arguments for ase.io.read."""

filename: Union[str, PurePath, IO]
index: Union[int, slice, str]
Expand All @@ -31,7 +32,7 @@ class ASEReadArgs(TypedDict, total=False):


class ASEWriteArgs(TypedDict, total=False):
"""Main arguments for ase.io.write"""
"""Main arguments for ase.io.write."""

filename: Union[str, PurePath, IO]
images: MaybeSequence[Atoms]
Expand All @@ -41,15 +42,15 @@ class ASEWriteArgs(TypedDict, total=False):


class ASEOptArgs(TypedDict, total=False):
"""Main arugments for ase optimisers"""
"""Main arugments for ase optimisers."""

restart: Optional[bool]
logfile: Optional[PathLike]
trajectory: PathLike


class ASEOptRunArgs(TypedDict, total=False):
"""Main arugments for running ase optimisers"""
"""Main arugments for running ase optimisers."""

fmax: float
steps: int
Expand All @@ -61,7 +62,7 @@ class ASEOptRunArgs(TypedDict, total=False):


class CalcResults(TypedDict, total=False):
"""Return type from calculations"""
"""Return type from calculations."""

energy: MaybeList[float]
forces: MaybeList[NDArray[np.float64]]
Expand Down

0 comments on commit 4a42aad

Please sign in to comment.