IFermi
0.2.6
Usage Guide
Introduction
Command-line interface
Python API introduction
Information
Change log
Contributors
Contributing to IFermi
License
IFermi on GitHub
Function Reference
API reference
Index
IFermi
ยป GitHub
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
Symbols
--azimuth <azimuth>
ifermi-plot command line option
--cmax <cmax>
ifermi-plot command line option
--cmin <cmin>
ifermi-plot command line option
--color-property
ifermi-plot command line option
--decimate-factor <decimate_factor>
ifermi-info command line option
ifermi-plot command line option
--elevation <elevation>
ifermi-plot command line option
--filename <filename>
ifermi-info command line option
ifermi-plot command line option
--hide-cell
ifermi-plot command line option
--hide-labels
ifermi-plot command line option
--hide-surface
ifermi-plot command line option
--interpolation-factor <interpolation_factor>
ifermi-info command line option
ifermi-plot command line option
--mu <mu>
ifermi-info command line option
ifermi-plot command line option
--no-color-property
ifermi-plot command line option
--no-norm
ifermi-info command line option
--no-vector-property
ifermi-plot command line option
--no-wigner
ifermi-info command line option
ifermi-plot command line option
--norm
ifermi-info command line option
--output <output_filename>
ifermi-plot command line option
--precision <precision>
ifermi-info command line option
--projection-axis <projection_axis>
ifermi-info command line option
ifermi-plot command line option
--property <property>
ifermi-info command line option
ifermi-plot command line option
--property-colormap <property_colormap>
ifermi-plot command line option
--scale <scale>
ifermi-plot command line option
--scale-linewidth
ifermi-plot command line option
--slice <slice>
ifermi-plot command line option
--smooth
ifermi-info command line option
ifermi-plot command line option
--spin <spin>
ifermi-plot command line option
--symprec <symprec>
ifermi-plot command line option
--type <plot_type>
ifermi-plot command line option
--vector-colormap <vector_colormap>
ifermi-plot command line option
--vector-property
ifermi-plot command line option
--vector-spacing <vector_spacing>
ifermi-plot command line option
--vnorm <vnorm>
ifermi-plot command line option
--wigner
ifermi-info command line option
ifermi-plot command line option
-a
ifermi-plot command line option
-e
ifermi-plot command line option
-f
ifermi-info command line option
ifermi-plot command line option
-i
ifermi-info command line option
ifermi-plot command line option
-m
ifermi-info command line option
ifermi-plot command line option
-o
ifermi-plot command line option
-s
ifermi-plot command line option
-t
ifermi-plot command line option
A
all_lines() (ifermi.slice.FermiSlice method)
all_properties() (ifermi.slice.FermiSlice method)
(ifermi.surface.FermiSurface method)
all_vertices_faces() (ifermi.surface.FermiSurface method)
area() (ifermi.surface.FermiSurface property)
(ifermi.surface.Isosurface property)
area_surfaces() (ifermi.surface.FermiSurface property)
as_dict() (ifermi.slice.FermiSlice method)
(ifermi.surface.FermiSurface method)
average_properties() (ifermi.surface.FermiSurface method)
(ifermi.surface.Isosurface method)
(in module ifermi.analysis)
average_properties_surfaces() (ifermi.surface.FermiSurface method)
B
band_idx (ifermi.slice.Isoline attribute)
(ifermi.surface.Isosurface attribute)
C
centers (ifermi.brillouin_zone.ReciprocalCell attribute)
(ifermi.brillouin_zone.WignerSeitzCell attribute)
cmap_to_mayavi() (in module ifermi.plot)
cmap_to_plotly() (in module ifermi.plot)
compute_isosurfaces() (in module ifermi.surface)
connected_images() (in module ifermi.analysis)
connected_subsurfaces() (in module ifermi.analysis)
D
decimate_mesh() (in module ifermi.surface)
dimensionality (ifermi.surface.Isosurface attribute)
E
edges() (ifermi.brillouin_zone.ReciprocalCell property)
(ifermi.brillouin_zone.ReciprocalSlice property)
equivalent_surfaces() (in module ifermi.analysis)
equivalent_vertices() (in module ifermi.analysis)
expand_bands() (in module ifermi.surface)
F
face_properties() (in module ifermi.surface)
faces (ifermi.brillouin_zone.ReciprocalCell attribute)
(ifermi.brillouin_zone.WignerSeitzCell attribute)
(ifermi.surface.Isosurface attribute)
FermiSlice (class in ifermi.slice)
FermiSlicePlotter (class in ifermi.plot)
FermiSurface (class in ifermi.surface)
FermiSurfacePlotter (class in ifermi.plot)
FourierInterpolator (class in ifermi.interpolate)
from_band_structure() (ifermi.surface.FermiSurface class method)
from_dict() (ifermi.slice.FermiSlice class method)
(ifermi.surface.FermiSurface class method)
from_fermi_surface() (ifermi.slice.FermiSlice class method)
from_structure() (ifermi.brillouin_zone.ReciprocalCell class method)
(ifermi.brillouin_zone.WignerSeitzCell class method)
G
get_face_arrows() (in module ifermi.plot)
get_fermi_slice() (ifermi.surface.FermiSurface method)
get_isosurface_colors() (in module ifermi.plot)
get_kpoint_mesh_dim() (in module ifermi.kpoints)
get_kpoint_spacing() (in module ifermi.kpoints)
get_plot() (ifermi.plot.FermiSlicePlotter method)
(ifermi.plot.FermiSurfacePlotter method)
get_plot_type() (in module ifermi.plot)
get_reciprocal_slice() (ifermi.brillouin_zone.ReciprocalCell method)
get_segment_arrows() (in module ifermi.plot)
get_symmetry_points() (ifermi.plot.FermiSlicePlotter static method)
(ifermi.plot.FermiSurfacePlotter static method)
H
has_properties() (ifermi.slice.FermiSlice property)
(ifermi.slice.Isoline property)
(ifermi.surface.FermiSurface property)
(ifermi.surface.Isosurface property)
I
ifermi-info command line option
--decimate-factor <decimate_factor>
--filename <filename>
--interpolation-factor <interpolation_factor>
--mu <mu>
--no-norm
--no-wigner
--norm
--precision <precision>
--projection-axis <projection_axis>
--property <property>
--smooth
--wigner
-f
-i
-m
ifermi-plot command line option
--azimuth <azimuth>
--cmax <cmax>
--cmin <cmin>
--color-property
--decimate-factor <decimate_factor>
--elevation <elevation>
--filename <filename>
--hide-cell
--hide-labels
--hide-surface
--interpolation-factor <interpolation_factor>
--mu <mu>
--no-color-property
--no-vector-property
--no-wigner
--output <output_filename>
--projection-axis <projection_axis>
--property <property>
--property-colormap <property_colormap>
--scale <scale>
--scale-linewidth
--slice <slice>
--smooth
--spin <spin>
--symprec <symprec>
--type <plot_type>
--vector-colormap <vector_colormap>
--vector-property
--vector-spacing <vector_spacing>
--vnorm <vnorm>
--wigner
-a
-e
-f
-i
-m
-o
-s
-t
ifermi.analysis
module
ifermi.brillouin_zone
module
ifermi.interpolate
module
ifermi.kpoints
module
ifermi.plot
module
ifermi.slice
module
ifermi.surface
module
interpolate() (ifermi.interpolate.LinearInterpolator method)
interpolate_bands() (ifermi.interpolate.FourierInterpolator method)
interpolate_segments() (in module ifermi.slice)
Isoline (class in ifermi.slice)
isolines (ifermi.slice.FermiSlice attribute)
Isosurface (class in ifermi.surface)
isosurface_area() (in module ifermi.analysis)
isosurface_dimensionality() (in module ifermi.analysis)
isosurfaces (ifermi.surface.FermiSurface attribute)
K
kpoints_from_bandstructure() (in module ifermi.kpoints)
kpoints_to_first_bz() (in module ifermi.kpoints)
L
line_orientation() (in module ifermi.analysis)
LinearInterpolator (class in ifermi.interpolate)
lines() (ifermi.brillouin_zone.ReciprocalCell property)
(ifermi.brillouin_zone.ReciprocalSlice property)
longest_simple_paths() (in module ifermi.analysis)
M
module
ifermi.analysis
ifermi.brillouin_zone
ifermi.interpolate
ifermi.kpoints
ifermi.plot
ifermi.slice
ifermi.surface
N
n_lines() (ifermi.slice.FermiSlice property)
n_lines_per_band() (ifermi.slice.FermiSlice property)
n_lines_per_spin() (ifermi.slice.FermiSlice property)
n_surfaces() (ifermi.surface.FermiSurface property)
n_surfaces_per_band() (ifermi.surface.FermiSurface property)
n_surfaces_per_spin() (ifermi.surface.FermiSurface property)
normals (ifermi.brillouin_zone.ReciprocalCell attribute)
(ifermi.brillouin_zone.WignerSeitzCell attribute)
O
orientation (ifermi.surface.Isosurface attribute)
P
plane_orientation() (in module ifermi.analysis)
plotly_arrow() (in module ifermi.plot)
process_lines() (in module ifermi.slice)
properties (ifermi.slice.Isoline attribute)
(ifermi.surface.Isosurface attribute)
properties_ndim() (ifermi.slice.FermiSlice property)
(ifermi.slice.Isoline property)
(ifermi.surface.FermiSurface property)
(ifermi.surface.Isosurface property)
properties_norms() (ifermi.slice.Isoline property)
(ifermi.surface.Isosurface property)
R
reciprocal_lattice (ifermi.brillouin_zone.ReciprocalCell attribute)
(ifermi.brillouin_zone.WignerSeitzCell attribute)
reciprocal_space (ifermi.brillouin_zone.ReciprocalSlice attribute)
(ifermi.slice.FermiSlice attribute)
(ifermi.surface.FermiSurface attribute)
ReciprocalCell (class in ifermi.brillouin_zone)
ReciprocalSlice (class in ifermi.brillouin_zone)
rgb_to_plotly() (in module ifermi.plot)
S
sample_line_uniform() (in module ifermi.analysis)
sample_surface_uniform() (in module ifermi.analysis)
sample_uniform() (ifermi.slice.Isoline method)
(ifermi.surface.Isosurface method)
save_plot() (in module ifermi.plot)
scalar_projection() (ifermi.slice.Isoline method)
(ifermi.surface.Isosurface method)
segments (ifermi.slice.Isoline attribute)
show_plot() (in module ifermi.plot)
sort_boltztrap_to_spglib() (in module ifermi.kpoints)
spins() (ifermi.slice.FermiSlice property)
(ifermi.surface.FermiSurface property)
structure (ifermi.slice.FermiSlice attribute)
(ifermi.surface.FermiSurface attribute)
T
transformation (ifermi.brillouin_zone.ReciprocalSlice attribute)
trim_bandstructure() (in module ifermi.interpolate)
trim_surface() (in module ifermi.surface)
V
vertices (ifermi.brillouin_zone.ReciprocalCell attribute)
(ifermi.brillouin_zone.ReciprocalSlice attribute)
(ifermi.brillouin_zone.WignerSeitzCell attribute)
(ifermi.surface.Isosurface attribute)
W
WignerSeitzCell (class in ifermi.brillouin_zone)