brille

You can use brille to:

• access spacegroup and pointgroup symmetry operations

• determine the first Brillouin zone for a given real space crystallographic lattice

• find an irreducible Brillouin zone polyhedron for a lattice

• construct a polyhedron-filling connected-point network

• perform linear-interpolation of user-provided data for any reciprocal space point at a symmetry-equivalent position within the connected point network.

User documents

• Installation Guide
• Introduction
• Memory Use
• User Guide

API documents

• Python module brille
• AngleUnit
  • AngleUnit.degree
  • AngleUnit.name
  • AngleUnit.not_provided
  • AngleUnit.pi
  • AngleUnit.radian
  • AngleUnit.value
• ApproxConfig
  • ApproxConfig.digits
  • ApproxConfig.real_space_tolerance
  • ApproxConfig.reciprocal_space_tolerance
• BZMeshQcc
  • BZMeshQcc.BrillouinZone
  • BZMeshQcc.bytes_per_point
  • BZMeshQcc.fill()
  • BZMeshQcc.from_file()
  • BZMeshQcc.invA
  • BZMeshQcc.ir_interpolate_at()
  • BZMeshQcc.rlu
  • BZMeshQcc.set_flags_weights()
  • BZMeshQcc.sort()
  • BZMeshQcc.tetrahedra
  • BZMeshQcc.to_file()
  • BZMeshQcc.values
  • BZMeshQcc.vectors
• BZMeshQdc
  • BZMeshQdc.BrillouinZone
  • BZMeshQdc.bytes_per_point
  • BZMeshQdc.fill()
  • BZMeshQdc.from_file()
  • BZMeshQdc.invA
  • BZMeshQdc.ir_interpolate_at()
  • BZMeshQdc.rlu
  • BZMeshQdc.set_flags_weights()
  • BZMeshQdc.sort()
  • BZMeshQdc.tetrahedra
  • BZMeshQdc.to_file()
  • BZMeshQdc.values
  • BZMeshQdc.vectors
• BZMeshQdd
  • BZMeshQdd.BrillouinZone
  • BZMeshQdd.bytes_per_point
  • BZMeshQdd.fill()
  • BZMeshQdd.from_file()
  • BZMeshQdd.invA
  • BZMeshQdd.ir_interpolate_at()
  • BZMeshQdd.rlu
  • BZMeshQdd.set_flags_weights()
  • BZMeshQdd.sort()
  • BZMeshQdd.tetrahedra
  • BZMeshQdd.to_file()
  • BZMeshQdd.values
  • BZMeshQdd.vectors
• BZNestQcc
  • BZNestQcc.BrillouinZone
  • BZNestQcc.all_invA
  • BZNestQcc.all_rlu
  • BZNestQcc.bytes_per_point
  • BZNestQcc.fill()
  • BZNestQcc.from_file()
  • BZNestQcc.invA
  • BZNestQcc.ir_interpolate_at()
  • BZNestQcc.rlu
  • BZNestQcc.set_flags_weights()
  • BZNestQcc.sort()
  • BZNestQcc.tetrahedra
  • BZNestQcc.to_file()
  • BZNestQcc.values
  • BZNestQcc.vectors
• BZNestQdc
  • BZNestQdc.BrillouinZone
  • BZNestQdc.all_invA
  • BZNestQdc.all_rlu
  • BZNestQdc.bytes_per_point
  • BZNestQdc.fill()
  • BZNestQdc.from_file()
  • BZNestQdc.invA
  • BZNestQdc.ir_interpolate_at()
  • BZNestQdc.rlu
  • BZNestQdc.set_flags_weights()
  • BZNestQdc.sort()
  • BZNestQdc.tetrahedra
  • BZNestQdc.to_file()
  • BZNestQdc.values
  • BZNestQdc.vectors
• BZNestQdd
  • BZNestQdd.BrillouinZone
  • BZNestQdd.all_invA
  • BZNestQdd.all_rlu
  • BZNestQdd.bytes_per_point
  • BZNestQdd.fill()
  • BZNestQdd.from_file()
  • BZNestQdd.invA
  • BZNestQdd.ir_interpolate_at()
  • BZNestQdd.rlu
  • BZNestQdd.set_flags_weights()
  • BZNestQdd.sort()
  • BZNestQdd.tetrahedra
  • BZNestQdd.to_file()
  • BZNestQdd.values
  • BZNestQdd.vectors
• BZTrellisQcc
  • BZTrellisQcc.BrillouinZone
  • BZTrellisQcc.all_node_types()
  • BZTrellisQcc.bytes_per_point
  • BZTrellisQcc.fill()
  • BZTrellisQcc.from_file()
  • BZTrellisQcc.inner_invA
  • BZTrellisQcc.inner_rlu
  • BZTrellisQcc.interpolate_at()
  • BZTrellisQcc.invA
  • BZTrellisQcc.ir_interpolate_at()
  • BZTrellisQcc.node_at()
  • BZTrellisQcc.node_at_type()
  • BZTrellisQcc.node_containing()
  • BZTrellisQcc.node_containing_type()
  • BZTrellisQcc.outer_invA
  • BZTrellisQcc.outer_rlu
  • BZTrellisQcc.rlu
  • BZTrellisQcc.set_flags_weights()
  • BZTrellisQcc.sort()
  • BZTrellisQcc.tetrahedra
  • BZTrellisQcc.to_file()
  • BZTrellisQcc.values
  • BZTrellisQcc.vectors
• BZTrellisQdc
  • BZTrellisQdc.BrillouinZone
  • BZTrellisQdc.all_node_types()
  • BZTrellisQdc.bytes_per_point
  • BZTrellisQdc.fill()
  • BZTrellisQdc.from_file()
  • BZTrellisQdc.inner_invA
  • BZTrellisQdc.inner_rlu
  • BZTrellisQdc.interpolate_at()
  • BZTrellisQdc.invA
  • BZTrellisQdc.ir_interpolate_at()
  • BZTrellisQdc.node_at()
  • BZTrellisQdc.node_at_type()
  • BZTrellisQdc.node_containing()
  • BZTrellisQdc.node_containing_type()
  • BZTrellisQdc.outer_invA
  • BZTrellisQdc.outer_rlu
  • BZTrellisQdc.rlu
  • BZTrellisQdc.set_flags_weights()
  • BZTrellisQdc.sort()
  • BZTrellisQdc.tetrahedra
  • BZTrellisQdc.to_file()
  • BZTrellisQdc.values
  • BZTrellisQdc.vectors
• BZTrellisQdd
  • BZTrellisQdd.BrillouinZone
  • BZTrellisQdd.all_node_types()
  • BZTrellisQdd.bytes_per_point
  • BZTrellisQdd.fill()
  • BZTrellisQdd.from_file()
  • BZTrellisQdd.inner_invA
  • BZTrellisQdd.inner_rlu
  • BZTrellisQdd.interpolate_at()
  • BZTrellisQdd.invA
  • BZTrellisQdd.ir_interpolate_at()
  • BZTrellisQdd.node_at()
  • BZTrellisQdd.node_at_type()
  • BZTrellisQdd.node_containing()
  • BZTrellisQdd.node_containing_type()
  • BZTrellisQdd.outer_invA
  • BZTrellisQdd.outer_rlu
  • BZTrellisQdd.rlu
  • BZTrellisQdd.set_flags_weights()
  • BZTrellisQdd.sort()
  • BZTrellisQdd.tetrahedra
  • BZTrellisQdd.to_file()
  • BZTrellisQdd.values
  • BZTrellisQdd.vectors
• Basis
  • Basis.positions
  • Basis.size
  • Basis.types
• Bravais
  • Bravais.A
  • Bravais.B
  • Bravais.C
  • Bravais.F
  • Bravais.I
  • Bravais.P
  • Bravais.R
  • Bravais.invalid
  • Bravais.name
  • Bravais.value
• BrillouinZone
  • BrillouinZone.faces_per_vertex
  • BrillouinZone.from_file()
  • BrillouinZone.half_edge_points
  • BrillouinZone.half_edge_points_invA
  • BrillouinZone.ir_faces_per_vertex
  • BrillouinZone.ir_moveinto()
  • BrillouinZone.ir_moveinto_wedge()
  • BrillouinZone.ir_normals
  • BrillouinZone.ir_normals_invA
  • BrillouinZone.ir_normals_primitive
  • BrillouinZone.ir_points
  • BrillouinZone.ir_points_invA
  • BrillouinZone.ir_points_primitive
  • BrillouinZone.ir_polyhedron
  • BrillouinZone.ir_polyhedron_generated
  • BrillouinZone.ir_vertices
  • BrillouinZone.ir_vertices_invA
  • BrillouinZone.ir_vertices_per_face
  • BrillouinZone.ir_vertices_primitive
  • BrillouinZone.isinside()
  • BrillouinZone.lattice
  • BrillouinZone.moveinto()
  • BrillouinZone.normals
  • BrillouinZone.normals_invA
  • BrillouinZone.normals_primitive
  • BrillouinZone.points
  • BrillouinZone.points_invA
  • BrillouinZone.points_primitive
  • BrillouinZone.polyhedron
  • BrillouinZone.to_file()
  • BrillouinZone.vertices
  • BrillouinZone.vertices_invA
  • BrillouinZone.vertices_per_face
  • BrillouinZone.vertices_primitive
  • BrillouinZone.wedge_normals
  • BrillouinZone.wedge_normals_invA
  • BrillouinZone.wedge_normals_primitive
• HallSymbol
  • HallSymbol.generators
• LPolyhedron
  • LPolyhedron.centre
  • LPolyhedron.faces
  • LPolyhedron.intersection()
  • LPolyhedron.mirror
  • LPolyhedron.normals
  • LPolyhedron.points
  • LPolyhedron.rotate()
  • LPolyhedron.to_Cartesian()
  • LPolyhedron.vertices
  • LPolyhedron.volume
• Lattice()
• LengthUnit
  • LengthUnit.angstrom
  • LengthUnit.inverse_angstrom
  • LengthUnit.name
  • LengthUnit.none
  • LengthUnit.real_lattice
  • LengthUnit.reciprocal_lattice
  • LengthUnit.value
• NodeType
  • NodeType.assumed_null
  • NodeType.cube
  • NodeType.found_null
  • NodeType.name
  • NodeType.null
  • NodeType.polygon
  • NodeType.value
• PointSymmetry
  • PointSymmetry.W
  • PointSymmetry.axis
  • PointSymmetry.generate
  • PointSymmetry.generators
  • PointSymmetry.isometry
  • PointSymmetry.nfolds()
  • PointSymmetry.order
  • PointSymmetry.size
• Pointgroup
  • Pointgroup.holohedry
  • Pointgroup.laue
  • Pointgroup.number
  • Pointgroup.symbol
• Polyhedron
  • Polyhedron.centre
  • Polyhedron.faces
  • Polyhedron.intersection()
  • Polyhedron.mirror
  • Polyhedron.normals
  • Polyhedron.points
  • Polyhedron.vertices
  • Polyhedron.volume
• PrimitiveTransform
  • PrimitiveTransform.P
  • PrimitiveTransform.Pt
  • PrimitiveTransform.does_anything
  • PrimitiveTransform.invP
  • PrimitiveTransform.invPt
  • PrimitiveTransform.is_primitive
• RotatesLike
  • RotatesLike.Gamma
  • RotatesLike.name
  • RotatesLike.pseudovector
  • RotatesLike.value
  • RotatesLike.vector
• SortingStatus
  • SortingStatus.locked
  • SortingStatus.sorted
  • SortingStatus.visits
• Spacegroup
  • Spacegroup.choice
  • Spacegroup.hall_number
  • Spacegroup.hall_symbol
  • Spacegroup.international_table_full
  • Spacegroup.international_table_number
  • Spacegroup.international_table_short
  • Spacegroup.international_table_symbol
  • Spacegroup.pointgroup_number
  • Spacegroup.schoenflies_symbol
• Symmetry
  • Symmetry.W
  • Symmetry.centring
  • Symmetry.generate()
  • Symmetry.generators()
  • Symmetry.size
  • Symmetry.w
• real_space_tolerance()
• reciprocal_space_tolerance()
• Documented thus far:
  • Lattices
  • Debugging
  • Brillouin Zone
  • Grids
  • Symmetry
  • Remainder
• Plotting utilities for brille
• plot()
• plot_bz()
• plot_points()
• plot_points_with_lines()
• plot_polyhedron()
• plot_tetrahedra()
• plot_tetrahedron()
• Utilities for brille
• create_bz()
• create_grid()
• Doxygen documentation
• Undocumented C++ Classes
  • pybind11 module brille._brille

Indices and tables

• Index

• Module Index

• Search Page