Skip to content

Commit

Permalink
chore: add missing docstrings for configs
Browse files Browse the repository at this point in the history
  • Loading branch information
VsevolodX committed Nov 22, 2024
1 parent e751119 commit 0ab124c
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions src/py/mat3ra/made/tools/build/interface/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,18 @@


class InterfaceConfiguration(BaseModel, InMemoryEntity):
"""
Configuration for an interface between two slabs.
Args:
film_configuration (SlabConfiguration): The configuration of the film slab.
substrate_configuration (SlabConfiguration): The configuration of the substrate slab.
film_termination (Termination): The termination of the film.
substrate_termination (Termination): The termination of the substrate.
distance_z (float): The distance between the film and the substrate in Angstroms.
vacuum (float): The vacuum thickness, in Angstroms.
"""

film_configuration: SlabConfiguration
substrate_configuration: SlabConfiguration
film_termination: Termination
Expand All @@ -36,6 +48,17 @@ def _json(self):


class TwistedInterfaceConfiguration(BaseConfiguration):
"""
Configuration for creating a twisted interface between two slabs with specified twist angle.
Args:
film (Material): The film material.
substrate (Material): The substrate material.
twist_angle (float): Twist angle in degrees.
distance_z (float): Vertical distance between layers in Angstroms.
vacuum (float): Vacuum thickness, in Angstroms.
"""

film: Material
substrate: Optional[Material] = None
twist_angle: float = 0.0
Expand Down

0 comments on commit 0ab124c

Please sign in to comment.