Table Of Contents

This Page

openbandparams package

Submodules

openbandparams.algorithms module

openbandparams.algorithms.bisect(func, a, b, xtol=1e-12, maxiter=100)[source]

Finds the root of func using the bisection method.

func must be continuous function that accepts a single number input
and returns a single number

func(a) and func(b) must have opposite sign

func : function
the function that we want to find the root of
a : number
one of the bounds on the input
b : number
the other bound on the input
xtol : number, optional
the solution tolerance of the input value. The algorithm is considered converged if abs(b-a)2. < xtol
maxiter : number, optional
the maximum number of iterations allowed for convergence
openbandparams.algorithms.sign(x)[source]

Returns -1, 0, or 1 if x is negative, zero, or positive, respectively.

openbandparams.base_material module

class openbandparams.base_material.Base[source]

Bases: object

classmethod elementFraction(element)[source]
elements = ()
name = 'Base'
class openbandparams.base_material.BaseType[source]

Bases: type

openbandparams.equations module

openbandparams.equations.varshni(Eg_0, alpha, beta, T)[source]

openbandparams.utils module

class openbandparams.utils.classinstancemethod(func)[source]

Bases: object

Acts like a class method when called from a class, like an instance method when called by an instance. The method should take two arguments, ‘self’ and ‘cls’. ‘self’ will be None if the method was called as a static or class method.

openbandparams.version module

Module contents

class openbandparams.AlN

Bases: openbandparams.iii_v.binary.Binary

elements = ('Al', 'N')
name = 'AlN'
class openbandparams.GaN

Bases: openbandparams.iii_v.binary.Binary

elements = ('Ga', 'N')
name = 'GaN'
class openbandparams.InN

Bases: openbandparams.iii_v.binary.Binary

elements = ('In', 'N')
name = 'InN'
class openbandparams.AlP

Bases: openbandparams.iii_v.binary.Binary

elements = ('Al', 'P')
name = 'AlP'
class openbandparams.GaP

Bases: openbandparams.iii_v.binary.Binary

classmethod Eg_Gamma(**kwargs)

Returns the Gamma-valley bandgap, Eg_Gamma, in electron Volts at a given temperature, T, in Kelvin (default: 300 K).

GaP has a unique Gamma-gap temperature dependence.

elements = ('Ga', 'P')
name = 'GaP'
class openbandparams.InP

Bases: openbandparams.iii_v.binary.Binary

elements = ('In', 'P')
name = 'InP'
class openbandparams.AlAs

Bases: openbandparams.iii_v.binary.Binary

elements = ('Al', 'As')
name = 'AlAs'
class openbandparams.GaAs

Bases: openbandparams.iii_v.binary.Binary

elements = ('Ga', 'As')
name = 'GaAs'
class openbandparams.InAs

Bases: openbandparams.iii_v.binary.Binary

elements = ('In', 'As')
name = 'InAs'
class openbandparams.AlSb

Bases: openbandparams.iii_v.binary.Binary

elements = ('Al', 'Sb')
name = 'AlSb'
class openbandparams.GaSb

Bases: openbandparams.iii_v.binary.Binary

elements = ('Ga', 'Sb')
name = 'GaSb'
class openbandparams.InSb

Bases: openbandparams.iii_v.binary.Binary

elements = ('In', 'Sb')
name = 'InSb'
class openbandparams.AlGaN(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (AlN, GaN)
elements = ('Al', 'Ga', 'N')
name = 'AlGaN'
class openbandparams.AlInN(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (AlN, InN)
elements = ('Al', 'In', 'N')
name = 'AlInN'
class openbandparams.GaInN(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (GaN, InN)
elements = ('Ga', 'In', 'N')
name = 'GaInN'
class openbandparams.AlGaP(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (AlP, GaP)
elements = ('Al', 'Ga', 'P')
name = 'AlGaP'
class openbandparams.AlInP(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (AlP, InP)
elements = ('Al', 'In', 'P')
name = 'AlInP'
class openbandparams.GaInP(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (GaP, InP)
elements = ('Ga', 'In', 'P')
name = 'GaInP'
class openbandparams.AlGaAs(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (AlAs, GaAs)
elements = ('Al', 'Ga', 'As')
name = 'AlGaAs'
class openbandparams.AlInAs(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (AlAs, InAs)
elements = ('Al', 'In', 'As')
name = 'AlInAs'
class openbandparams.GaInAs(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (GaAs, InAs)
elements = ('Ga', 'In', 'As')
name = 'GaInAs'
class openbandparams.AlGaSb(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (AlSb, GaSb)
elements = ('Al', 'Ga', 'Sb')
name = 'AlGaSb'
class openbandparams.AlInSb(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (AlSb, InSb)
elements = ('Al', 'In', 'Sb')
name = 'AlInSb'
class openbandparams.GaInSb(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary1

binaries = (GaSb, InSb)
elements = ('Ga', 'In', 'Sb')
name = 'GaInSb'
class openbandparams.AlNP(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (AlN, AlP)
elements = ('Al', 'N', 'P')
name = 'AlNP'
class openbandparams.GaNP(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (GaN, GaP)
elements = ('Ga', 'N', 'P')
name = 'GaNP'
class openbandparams.InNP(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (InN, InP)
elements = ('In', 'N', 'P')
name = 'InNP'
class openbandparams.AlNAs(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (AlN, AlAs)
elements = ('Al', 'N', 'As')
name = 'AlNAs'
class openbandparams.GaNAs(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (GaN, GaAs)
elements = ('Ga', 'N', 'As')
name = 'GaNAs'
class openbandparams.InNAs(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (InN, InAs)
elements = ('In', 'N', 'As')
name = 'InNAs'
class openbandparams.AlPAs(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (AlP, AlAs)
elements = ('Al', 'P', 'As')
name = 'AlPAs'
class openbandparams.GaPAs(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (GaP, GaAs)
elements = ('Ga', 'P', 'As')
name = 'GaPAs'
class openbandparams.InPAs(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (InP, InAs)
elements = ('In', 'P', 'As')
name = 'InPAs'
class openbandparams.AlPSb(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (AlP, AlSb)
elements = ('Al', 'P', 'Sb')
name = 'AlPSb'
class openbandparams.GaPSb(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (GaP, GaSb)
elements = ('Ga', 'P', 'Sb')
name = 'GaPSb'
class openbandparams.InPSb(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (InP, InSb)
elements = ('In', 'P', 'Sb')
name = 'InPSb'
class openbandparams.AlAsSb(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (AlAs, AlSb)
elements = ('Al', 'As', 'Sb')
name = 'AlAsSb'
class openbandparams.GaAsSb(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (GaAs, GaSb)
elements = ('Ga', 'As', 'Sb')
name = 'GaAsSb'
class openbandparams.InAsSb(**kwargs)

Bases: openbandparams.iii_v.ternary.Ternary2

binaries = (InAs, InSb)
elements = ('In', 'As', 'Sb')
name = 'InAsSb'
class openbandparams.AlNPAs(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary1

binaries = (AlN, AlP, AlAs)
elements = ('Al', 'N', 'P', 'As')
name = 'AlNPAs'
ternaries = (AlNP, AlNAs, AlPAs)
class openbandparams.AlPAsSb(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary1

binaries = (AlP, AlAs, AlSb)
elements = ('Al', 'P', 'As', 'Sb')
name = 'AlPAsSb'
ternaries = (AlPAs, AlPSb, AlAsSb)
class openbandparams.GaNPAs(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary1

binaries = (GaN, GaP, GaAs)
elements = ('Ga', 'N', 'P', 'As')
name = 'GaNPAs'
ternaries = (GaNP, GaNAs, GaPAs)
class openbandparams.GaPAsSb(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary1

binaries = (GaP, GaAs, GaSb)
elements = ('Ga', 'P', 'As', 'Sb')
name = 'GaPAsSb'
ternaries = (GaPAs, GaPSb, GaAsSb)
class openbandparams.InNPAs(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary1

binaries = (InN, InP, InAs)
elements = ('In', 'N', 'P', 'As')
name = 'InNPAs'
ternaries = (InNP, InNAs, InPAs)
class openbandparams.InPAsSb(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary1

binaries = (InP, InAs, InSb)
elements = ('In', 'P', 'As', 'Sb')
name = 'InPAsSb'
ternaries = (InPAs, InPSb, InAsSb)
class openbandparams.AlGaInN(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary2

binaries = (AlN, GaN, InN)
elements = ('Al', 'Ga', 'In', 'N')
name = 'AlGaInN'
ternaries = (AlGaN, AlInN, GaInN)
class openbandparams.AlGaInP(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary2

binaries = (AlP, GaP, InP)
elements = ('Al', 'Ga', 'In', 'P')
name = 'AlGaInP'
ternaries = (AlGaP, AlInP, GaInP)
class openbandparams.AlGaInAs(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary2

binaries = (AlAs, GaAs, InAs)
elements = ('Al', 'Ga', 'In', 'As')
name = 'AlGaInAs'
ternaries = (AlGaAs, AlInAs, GaInAs)
class openbandparams.AlGaInSb(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary2

binaries = (AlSb, GaSb, InSb)
elements = ('Al', 'Ga', 'In', 'Sb')
name = 'AlGaInSb'
ternaries = (AlGaSb, AlInSb, GaInSb)
class openbandparams.AlGaNP(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (AlN, AlP, GaN, GaP)
elements = ('Al', 'Ga', 'N', 'P')
name = 'AlGaNP'
ternaries = (AlGaN, AlGaP, AlNP, GaNP)
class openbandparams.AlInNP(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (AlN, AlP, InN, InP)
elements = ('Al', 'In', 'N', 'P')
name = 'AlInNP'
ternaries = (AlInN, AlInP, AlNP, InNP)
class openbandparams.GaInNP(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (GaN, GaP, InN, InP)
elements = ('Ga', 'In', 'N', 'P')
name = 'GaInNP'
ternaries = (GaInN, GaInP, GaNP, InNP)
class openbandparams.AlGaNAs(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (AlN, AlAs, GaN, GaAs)
elements = ('Al', 'Ga', 'N', 'As')
name = 'AlGaNAs'
ternaries = (AlGaN, AlGaAs, AlNAs, GaNAs)
class openbandparams.AlInNAs(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (AlN, AlAs, InN, InAs)
elements = ('Al', 'In', 'N', 'As')
name = 'AlInNAs'
ternaries = (AlInN, AlInAs, AlNAs, InNAs)
class openbandparams.GaInNAs(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (GaN, GaAs, InN, InAs)
elements = ('Ga', 'In', 'N', 'As')
name = 'GaInNAs'
ternaries = (GaInN, GaInAs, GaNAs, InNAs)
class openbandparams.AlGaPAs(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (AlP, AlAs, GaP, GaAs)
elements = ('Al', 'Ga', 'P', 'As')
name = 'AlGaPAs'
ternaries = (AlGaP, AlGaAs, AlPAs, GaPAs)
class openbandparams.AlInPAs(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (AlP, AlAs, InP, InAs)
elements = ('Al', 'In', 'P', 'As')
name = 'AlInPAs'
ternaries = (AlInP, AlInAs, AlPAs, InPAs)
class openbandparams.GaInPAs(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (GaP, GaAs, InP, InAs)
elements = ('Ga', 'In', 'P', 'As')
name = 'GaInPAs'
ternaries = (GaInP, GaInAs, GaPAs, InPAs)
class openbandparams.AlGaPSb(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (AlP, AlSb, GaP, GaSb)
elements = ('Al', 'Ga', 'P', 'Sb')
name = 'AlGaPSb'
ternaries = (AlGaP, AlGaSb, AlPSb, GaPSb)
class openbandparams.AlInPSb(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (AlP, AlSb, InP, InSb)
elements = ('Al', 'In', 'P', 'Sb')
name = 'AlInPSb'
ternaries = (AlInP, AlInSb, AlPSb, InPSb)
class openbandparams.GaInPSb(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (GaP, GaSb, InP, InSb)
elements = ('Ga', 'In', 'P', 'Sb')
name = 'GaInPSb'
ternaries = (GaInP, GaInSb, GaPSb, InPSb)
class openbandparams.AlGaAsSb(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (AlAs, AlSb, GaAs, GaSb)
elements = ('Al', 'Ga', 'As', 'Sb')
name = 'AlGaAsSb'
ternaries = (AlGaAs, AlGaSb, AlAsSb, GaAsSb)
class openbandparams.AlInAsSb(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (AlAs, AlSb, InAs, InSb)
elements = ('Al', 'In', 'As', 'Sb')
name = 'AlInAsSb'
ternaries = (AlInAs, AlInSb, AlAsSb, InAsSb)
class openbandparams.GaInAsSb(**kwargs)

Bases: openbandparams.iii_v.quaternary.Quaternary3

binaries = (GaAs, GaSb, InAs, InSb)
elements = ('Ga', 'In', 'As', 'Sb')
name = 'GaInAsSb'
ternaries = (GaInAs, GaInSb, GaAsSb, InAsSb)