sisl.Lattice
============















.. currentmodule:: sisl

.. autoclass:: Lattice







   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         


   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         
            

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
      

   
      
         
      
         
      
         
            
      

   
      
         
      
         
      
      

   
      
         
      
         
      
      

   
      
         
      
         
      
      

   
      
         
      
         
      
      

   
      
         
      
         
      
      

   
      
         
      
         
      
      

   
      
         
      
         
      
      

   
      
         
      
         
      
      

   
      
         
      
         
      
      

   
      
         
      
         
      
      

   
      
         
      
         
      
      







   .. rubric:: Conversion

   .. autosummary::
      :removeprefix: Lattice.

      
      Lattice.new
      
      





   

   

   

   

   

   

   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      Lattice.new.Sile

   
      
      Lattice.new.ase

   
      
      Lattice.new.ndarray

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      Lattice.to
      
      





   

   

   

   

   

   

   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      Lattice.to.Cuboid

   
      
      Lattice.to.Path

   
      
      Lattice.to.Sile

   
      
      Lattice.to.ase

   
      
      Lattice.to.str

   

   

   

   

   

   

   












   .. rubric:: Methods

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.add

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.add_vacuum

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.angle

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.append

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.area

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.cell2length

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.center

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.copy

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.equal

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.fit

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.is_cartesian

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.is_orthogonal

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.lengthf

   

   

   
   

   
      
      
      
      
         

   

   

   

   
   

   
      
      
      
      
         

   

   

   

   
   

   
      
      
      
      
         

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.offset

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.parallel

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.parameters

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.plane

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.prepend

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.read

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.repeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.rotate

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.sc_index

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.scale

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.set_boundary_condition

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.set_nsc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.swapaxes

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.tile

   

   

   
   

   
      
      
      
         
      

   

   

   

   
   

   
      
      
      
         
      

   

   

   

   
   

   
      
      
      
         
      

   

   

   

   
   

   
      
      
      
         
      

   

   

   

   
   

   
      
      
      
         
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.toCuboid

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.tocell

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.unrepeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.untile

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.vertices

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.volumef

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.write




   .. rubric:: Attributes

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.cell

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.nsc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.n_s

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.boundary_condition

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.icell

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.isc_off

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.length

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.origin

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.pbc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.rcell

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.sc_off

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Lattice.volume