Structure generators (sknano.generators)¶
Introduction¶
The sknano.generators package provides classes for generating structure data
for crystal structures and nanostructures.
Getting Started¶
Crystal structure generator classes are sub-classes of
CrystalStructureGenerator, while
nanostructure generator classes inherit from
NanoStructureGenerator base class.
Both CrystalStructureGenerator and
NanoStructureGenerator inherit from
GeneratorBase base class.
The GeneratorMixin class provides a simple concrete
implementation of the generate method.
Example:
>>> from sknano.generators import SWNTGenerator
Reference/API¶
sknano.generators Package¶
Classes¶
AlphaQuartzGenerator(*args[, autogen, finalize]) |
AlphaQuartz generator class. |
BCCGenerator(*args[, autogen, finalize]) |
BCCStructure generator class. |
BCCStructureGenerator |
alias of BCCGenerator |
BilayerGrapheneGenerator(*args[, autogen, ...]) |
Bilayer graphene structure generator class. |
CaesiumChlorideGenerator(*args[, autogen, ...]) |
CaesiumChlorideStructure generator class. |
CaesiumChlorideStructureGenerator |
alias of CaesiumChlorideGenerator |
CappedNanotubeGeneratorMixin |
Mixin class for generating capped nanotubes. |
ConventionalCellGrapheneGenerator(*args[, ...]) |
N-layer graphene generator class using a conventional unit cell. |
CopperGenerator(*args[, autogen, finalize]) |
Copper generator class. |
CrystalStructureGenerator(*args[, autogen, ...]) |
GeneratorBase sub-class for CrystalStructureBases |
CsClGenerator |
alias of CaesiumChlorideGenerator |
DiamondGenerator(*args[, autogen, finalize]) |
DiamondStructure generator class. |
DiamondStructureGenerator |
alias of DiamondGenerator |
FCCGenerator(*args[, autogen, finalize]) |
FCCStructure generator class. |
FCCStructureGenerator |
alias of FCCGenerator |
FullereneGenerator(*args[, autogen, finalize]) |
Fullerene structure generator class. |
GeneratorBase(*args[, autogen, finalize]) |
Base structure generator class. |
GeneratorConfigParser([cfgfile, structure]) |
Class for reading/writing ini config files. |
GeneratorMixin |
Mixin class with concrete implementation of generate method. |
GoldGenerator(*args[, autogen, finalize]) |
Gold generator class. |
GrapheneGenerator(*args[, autogen, finalize]) |
N-layer graphene generator class. |
GrapheneGeneratorBase(*args[, autogen, finalize]) |
N-layer graphene generator class. |
HexagonalCellGrapheneGenerator |
alias of PrimitiveCellGrapheneGenerator |
HexagonalGrapheneGenerator |
alias of PrimitiveCellGrapheneGenerator |
IronGenerator(*args[, autogen, finalize]) |
Iron generator class. |
LayeredStructureGenerator([cfgfile]) |
Class for generating structures. |
MWNTGenerator(*args[, from_scaling_matrix]) |
Class for generating multi-walled nanotubes (MWNT). |
MWNTGeneratorBase(*args[, autogen, finalize]) |
Mixin MWNT structure generator. |
MoS2Generator(*args[, autogen, finalize]) |
MoS2 generator class. |
NaClGenerator |
alias of RocksaltGenerator |
NanoStructureGenerator(*args[, autogen, ...]) |
GeneratorBase sub-class for NanoStructureBase class. |
NanotubeBundleGeneratorBase(*args[, ...]) |
Base class for generating nanotubes. |
PrimitiveCellGrapheneGenerator(*args[, ...]) |
N-layer graphene generator class using a primitive unit cell. |
RectangularCellGrapheneGenerator |
alias of ConventionalCellGrapheneGenerator |
RectangularGrapheneGenerator |
alias of ConventionalCellGrapheneGenerator |
RocksaltGenerator(*args[, autogen, finalize]) |
RocksaltStructure generator class. |
RocksaltStructureGenerator |
alias of RocksaltGenerator |
SWNTGenerator(*args[, from_scaling_matrix]) |
Class for generating SWNT structures. |
SWNTGeneratorBase(*args[, autogen, finalize]) |
Base SWNT generator class. |
UnrolledSWNTGenerator(*args[, autogen, finalize]) |
Class for generating unrolled nanotube structures. |
ZincblendeGenerator(*args[, autogen, finalize]) |
ZincblendeStructure generator class. |
ZincblendeStructureGenerator |
alias of ZincblendeGenerator |
Class Inheritance Diagram¶
