lucydot/effmass

Search.setIndex({docnames:["API documentation","Acknowledgements","Citing","Contributors","Development","Features","Implementation","Installation","License","Related packages","Supported codes","Testing","analysis","dos","extrema","index","inputs","outputs"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["API documentation.rst","Acknowledgements.rst","Citing.rst","Contributors.rst","Development.rst","Features.rst","Implementation.rst","Installation.rst","License.rst","Related packages.rst","Supported codes.rst","Testing.rst","analysis.rst","dos.rst","extrema.rst","index.rst","inputs.rst","outputs.rst"],objects:{"effmass.analysis":{Segment:[12,1,1,""],SegmentVasp:[12,1,1,""]},"effmass.analysis.Segment":{__init__:[12,2,1,""],alpha:[12,2,1,""],band:[12,3,1,""],band_type:[12,3,1,""],cartesian_kpoints:[12,3,1,""],dE_eV:[12,3,1,""],dE_hartree:[12,3,1,""],direction:[12,3,1,""],dk_angs:[12,3,1,""],dk_bohr:[12,3,1,""],energies:[12,3,1,""],explosion_index:[12,2,1,""],fd:[12,2,1,""],fermi_energy:[12,3,1,""],finite_difference_effmass:[12,2,1,""],finite_difference_fit:[12,2,1,""],five_point_leastsq_effmass:[12,2,1,""],five_point_leastsq_fit:[12,2,1,""],inertial_effmass:[12,2,1,""],kane_fit:[12,2,1,""],kane_mass_band_edge:[12,2,1,""],kpoint_indices:[12,3,1,""],kpoints:[12,3,1,""],mass_integration:[12,2,1,""],occupancy:[12,3,1,""],optical_effmass_kane_dispersion:[12,2,1,""],optical_poly_effmass:[12,2,1,""],poly_derivatives:[12,2,1,""],poly_fit:[12,2,1,""],transport_effmass:[12,2,1,""],weight_integration:[12,2,1,""],weighted_leastsq_effmass:[12,2,1,""],weighted_leastsq_fit:[12,2,1,""],weighting:[12,2,1,""]},"effmass.analysis.SegmentVasp":{__init__:[12,2,1,""]},"effmass.dos":{electron_fill_level:[13,4,1,""],find_dos_CBM_index:[13,4,1,""],find_dos_VBM_index:[13,4,1,""],hole_fill_level:[13,4,1,""]},"effmass.extrema":{calc_CBM_VBM_from_Fermi:[14,4,1,""],calculate_direction:[14,4,1,""],change_direction:[14,4,1,""],find_extrema_indices:[14,4,1,""],generate_segments:[14,4,1,""],get_kpoints_after:[14,4,1,""],get_kpoints_before:[14,4,1,""]},"effmass.inputs":{Data:[16,1,1,""],DataASE:[16,1,1,""],DataAims:[16,1,1,""],DataCastep:[16,1,1,""],DataVasp:[16,1,1,""],Settings:[16,1,1,""]},"effmass.inputs.Data":{CBM:[16,3,1,""],VBM:[16,3,1,""],__init__:[16,2,1,""],check_data:[16,2,1,""],energies:[16,3,1,""],fermi_energy:[16,3,1,""],kpoints:[16,3,1,""],number_of_bands:[16,3,1,""],number_of_kpoints:[16,3,1,""],occupancy:[16,3,1,""],reciprocal_lattice:[16,3,1,""],spin_channels:[16,3,1,""]},"effmass.inputs.DataASE":{__init__:[16,2,1,""]},"effmass.inputs.DataAims":{CBM:[16,3,1,""],VBM:[16,3,1,""],__init__:[16,2,1,""],energies:[16,3,1,""],fermi_energy:[16,3,1,"id0"],kpoints:[16,3,1,""],number_of_bands:[16,3,1,"id1"],number_of_kpoints:[16,3,1,""],occupancy:[16,3,1,""],reciprocal_lattice:[16,3,1,"id2"],spin_channels:[16,3,1,"id3"]},"effmass.inputs.DataCastep":{__init__:[16,2,1,""]},"effmass.inputs.DataVasp":{__init__:[16,2,1,""],parse_DOSCAR:[16,2,1,""]},"effmass.inputs.Settings":{__init__:[16,2,1,""],check_settings:[16,2,1,""]},effmass:{analysis:[12,0,0,"-"],dos:[13,0,0,"-"],extrema:[14,0,0,"-"],inputs:[16,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"025":16,"100":12,"10000":16,"100mb":7,"2018":[2,8],"20packag":5,"2alpha":12,"2e_":6,"2m_":12,"300":12,"797":2,"break":16,"case":[13,16],"class":[0,10,12,13,14,15,16],"default":[12,14,16],"float":[12,13,14,16],"function":[0,5,9,12,14,15,16],"import":12,"int":[12,13,14,16],"new":1,"return":[12,13,14,16],"true":[12,14],AND:8,ASE:[5,10,16],Axes:[],BUT:8,DOS:[9,12,16],FOR:8,For:[5,13,14],NOT:8,THE:8,The:[0,2,5,6,8,9,12,13,14,15,16],There:16,These:5,USE:8,Uses:13,Using:5,WITH:8,__init__:[12,16],abl:4,abov:[8,9,16],access:5,accord:12,account:9,acknowledg:15,across:12,action:8,addit:[12,16],advantag:9,after:14,against:[],aim:[0,3,9,10,16],aka:5,all:[4,6,8,12,13,16],along:[9,12],alpha:[9,12],also:[0,5,9,15,16],although:12,analys:[0,12,13,16],analysi:[0,15,16],angstrom:[12,13,16],ani:[8,14],anisotropi:9,api:[5,15],append:16,approxim:[5,9,12,15],arg:14,argument:[12,16],aris:8,aron:1,arrai:[12,13,14,16],ase:16,assess:5,associ:[8,15],assum:[5,9,12],atom:16,attribut:[12,16],author:[8,15],autom:11,automat:16,avail:[10,12,15],averag:9,axes:[],axi:12,band:[0,5,9,12,14,16],band_index:14,band_structur:16,band_typ:12,bandedg:[12,16],bandfit:16,bandstructur:[5,10,12,15,16],basic:[5,9,16],been:[11,16],befor:[7,14],begin:16,being:14,belong:14,below:[9,16],benjamin:[1,3],best:7,better:[5,9],between:[12,13,14],bibtex:[2,15],bjmorgan:[3,5],bohr:12,bool:[12,14],brillouin:5,bug:4,built:7,calc_cbm_vbm_from_fermi:14,calcul:[0,5,9,12,14,15,16],calculate_direct:14,can:[5,7,11,16],cancel:12,captur:5,carrier:5,cartesian:12,cartesian_kpoint:12,castep:[5,10,16],cbm:[13,14,16],cbm_index:13,cbmvbm_search_depth:14,cell:[12,13,16],centr:1,certain:5,chang:[12,14],change_direct:14,channel:16,charg:8,check:[14,16],check_data:16,check_set:16,chemist:9,choic:12,choos:9,citat:[2,15],cite:15,ck_i:6,claim:8,clone:7,code:[0,1,2,4,9,11,15,16],coeffici:6,colleg:1,com:[5,7,15],come:14,command:[5,7],commit:11,compar:9,compat:3,concentr:[5,13],condit:8,conduct:[4,5,9,12,14,16],conduction_band:12,confirm:16,connect:8,consist:[15,16],constant:12,construct:12,contact:15,contain:[0,12,14,15,16],contract:8,contribut:[4,10],contributor:[4,15],control:16,coordin:[12,14,16],copi:8,copyright:8,core:15,correspond:[5,12],count:12,coupl:16,current:[0,10,16],curvatur:[5,9,12,15],cut:16,d2edk2:12,damag:8,data:[0,5,12,13,14,16],data_aim:[],dataaim:[0,16],dataas:[14,16],datacastep:16,datavasp:[12,16],de_ev:12,de_hartre:12,deal:8,dedk:12,defin:[9,12],definit:[0,5,12,15],degre:16,degree_bandfit:16,delta:12,densiti:[5,12,13,16],depend:[5,9,13],deriv:[5,12,16],describ:12,determin:[12,16],develop:[1,3,7,15],dft:[5,6,9,12],differ:[6,9,12],differenti:14,dimension:[12,14,16],dirac:12,direct:[12,14],directori:16,directory_path:16,disk:7,dispers:[5,6,9,12,15,16],distanc:12,distribut:[8,12],dk_ang:12,dk_bohr:12,doctor:1,document:[3,8],doe:[9,16],dos:[0,12,15,16],doscar:[0,5,13,16],download:7,dure:1,e_f:6,e_i:[6,12],e_k:12,each:[0,12,14,16],easili:9,ecosystem:7,edg:[9,12],edit:16,effect:[0,2,5,9,12,15],effmass:[0,2,4,5,7,10],efmma:14,eigenst:[12,14,16],eigenvalu:6,electron:[0,4,12,13,15,16],electron_fill_level:13,element:14,emaf:9,emc:9,energi:[0,5,6,9,12,13,14,16],energy_rang:[14,16],epsrc:1,eqn:6,equat:6,especi:10,estim:[6,13],evalu:12,evenli:12,event:8,exampl:15,exce:13,exp:6,expect:12,explod:12,explosion_index:12,express:[8,16],extend:[4,12,16],extent:5,extrema:[0,5,9,12,15,16],extrema_search_depth:16,factor:12,fals:[12,14],familiar:[5,9],featur:[4,15],fermi:[5,12,14,16],fermi_energi:[12,16],fermi_level:12,fhi:[0,3,10,16],figur:[],file:[0,5,8,16],file_path:[],filenam:16,fill:13,find:[0,12,13,14,16],find_cbm_vbm:16,find_dos_cbm_index:13,find_dos_vbm_index:13,find_extrema_indic:14,finit:[6,9,12],finite_difference_effmass:12,finite_difference_fit:12,first:[12,14],fit:[5,6,8,9,12,16],five:6,five_point_leastsq_effmass:12,five_point_leastsq_fit:12,follow:[2,8,9],form:12,format:[14,16],forward:[6,12],found:[0,14],frac:[6,12],fraction:[12,14,16],free:8,from:[0,4,6,7,8,12,13,14,15,16],fund:1,furnish:8,futur:10,gap:[14,16],gener:[0,6,14,16],generate_seg:14,geometri:[0,16],get_kpoints_aft:14,get_kpoints_befor:14,git:[7,15],github:[4,5,7,9,15],give:12,given:[0,5,6,12,13,14,16],gmail:[],goloumb:3,gradient:12,grant:[1,8],happen:11,hartre:12,has:[11,16],have:[5,7,9],hbar:12,header:16,help:10,here:[5,9,11,15],herebi:8,high:9,higher:5,highest:13,holder:8,hole:13,hole_fill_level:13,homebrew:7,hope:10,html:5,http:[5,15],hybrid:16,ignor:16,imperi:1,implement:15,impli:8,includ:[6,8,12,16],independ:16,index:[12,13,14],indic:[12,14],inerti:[5,12],inertial_effmass:12,infer:16,inform:9,inherit:[12,16],initialis:[12,16],input:[0,12,14,15],instal:[9,15],instanc:[12,13,14,16],instanti:[0,14],integr:[12,16],integrated_do:[12,13,16],intercept:12,interest:5,interfac:[5,7,10,16],interpol:13,invers:12,invert:12,ion:[],issu:[4,9],journal:2,jupyt:15,k_bt:6,k_i:[6,12],kane:[5,9,12],kane_fit:12,kane_mass_band_edg:12,kavanagh:3,kavanas:3,kei:7,keyword:16,kind:8,knowledg:9,kpoint:[0,12,14,16],kpoint_index:14,kpoint_indic:[12,14],kspace:16,kwarg:16,l01551x:1,label:[],latest:[5,7,11],lattic:16,lead:3,least:[6,9,12],left:6,length:12,less:13,level:[5,9,12,14,16],liabil:8,liabl:8,librari:6,licens:15,like:4,limit:[0,8,12,16],line:[5,7,12],linear:[5,12,13],list:[5,9,12,14,16],locat:[5,15,16],london:1,longer:12,look:[5,9],lowest:13,luci:[1,2,3,8,15],lucydot:[3,7,15],lucywhallei:[],m_o:12,m_t:12,magnitud:14,mai:[5,7,9,12],main:6,make:[10,16],manag:7,manual:[11,14,16],mark:12,mass:[0,2,5,9,12,15,16],mass_bandedg:12,mass_integr:12,materi:[15,16],math:12,matlab:9,matplotlib:7,matthia:3,matthiasgolomb:3,maxima:5,maximum:[14,16],mean:[12,16],meaning:16,merchant:8,merg:8,method:[0,9,12,15,16],middl:14,minima:5,minimis:6,minimum:[14,16],modifi:8,modul:[0,12,13,14,15,16],momentum:12,more:[5,10,13,16],morgan:[1,3],mstar:9,multipl:9,must:[4,12],name:16,need:[5,9,16],neg:12,nice:10,non:[5,9,16],none:[12,13,14,16],noninfring:8,normalis:12,northumbria:15,note:[5,7,12,13,16],notebook:15,notic:8,num_data_point:16,number:[12,16],number_of_band:16,number_of_ion:[],number_of_kpoint:[14,16],numer:9,numpi:[6,7],object:[0,12,14,16],obtain:[6,8],occup:[12,14,16],occupi:[5,12,16],one:[5,9,12,16],onli:[5,12],open:2,optic:[5,9,12],optical_effmass_kane_dispers:12,optical_poly_effmass:12,option:[12,16],orbit:16,order:[5,9,12],origin:1,other:[4,8,10,15],otherwis:8,our:9,out:[0,8,12,16],outcar:[0,16],outcar_path:16,output:[0,4,5,15,16],over:[5,6,9,12,14,16],overlaid:[],packag:[0,1,2,5,7,15,16],paper:2,parabol:[5,6,9,12],paramet:[0,5,9,12,13,14,16],parent:16,pars:[0,4,5,16],parse_doscar:16,partial:6,particular:[4,8,12,16],pass:12,path:[9,16],per:16,permiss:8,permit:8,person:8,perturb:9,phd:1,photovolta:1,physicist:9,pip3:[],pip:7,plai:10,pleas:[2,4,9],plot:[5,15],plot_do:[],plot_integrated_do:[],plot_seg:[],plu:[6,12],point:[0,6,12,13,14,16],polaris:16,poly_deriv:12,poly_fit:12,polyfit:12,polyfit_ord:12,polyfit_weight:12,polynomi:[5,9,12,16],poor:12,portion:8,posit:[6,14],preced:16,precis:13,prefer:7,previou:16,prior:12,probabl:12,procar:[0,16],procar_path:16,product:12,properti:15,provid:[0,5,8,9,15,16],publish:8,pull:4,purpos:8,pymatgen:[9,10],pyplot:[],pytest:11,python3:[7,11],python:[5,6,7,9,11,15],quadrat:[5,9,12],quantifi:[5,9],quasi:[5,12],quasi_fermi_level:12,rais:12,rang:[0,5,9,14,16],read:[4,5,16],readthedoc:5,reciproc:[6,9,12,14,16],reciprocal_lattic:16,referec:14,referenc:13,region:12,rel:12,relat:[5,15],releas:7,reli:14,report:4,repositori:15,request:4,requir:[5,7,9],research:[2,10],residu:6,resolut:13,respect:4,rest:12,restrict:8,result:13,right:[6,8],rout:14,row:[12,14,16],run:[11,16],same:[7,14],sampl:16,sane:16,sanity_check:[],scale:[],scipi:7,sean:3,search:16,second:[12,14],see:[12,14],seebeck:9,seednam:16,segment:[0,5,12,14,15,16],segmentvasp:12,select:[5,15],self:16,sell:8,semiconduct:15,sens:16,set:[0,12,14,16],setup:7,shall:8,shape:[14,16],should:16,sign:12,similar:16,simpli:7,size:[],slice:[5,12,16],smallest:14,smear:5,softwar:[2,8],solid:9,some:12,sourc:[2,12,13,14,15,16],space:[6,7,9,12,14,16],specif:9,specifi:[12,13],spectrum:16,spin:16,spin_channel:16,squar:[6,9,12],start:[7,12],state:[5,9,12,13,16],statist:12,store:[0,16],str:[12,16],straight:12,structur:[0,4,14,16],subject:8,sublicens:8,substanti:8,suffix:16,suit:[5,9],sum:[6,12],sum_i:12,summaris:[],summat:6,sumo:9,supervis:1,support:[0,3,5,15,16],sustain:1,symmetri:[6,9,12],tailor:9,take:[9,12],taken:16,techniqu:9,temp:12,temperatur:[9,12],tensor:9,test:15,text:6,than:[13,16],thei:[7,12],them:7,theoret:9,theori:9,thermal:5,thi:[1,2,5,8,9,11,12,14,16],those:[5,12],three:6,through:[1,5,9,12,14,16],togeth:7,tort:8,toward:9,tracker:[4,9],train:1,transport:[5,12,16],transport_effmass:12,truncat:[12,14],truncate_dir_chang:14,tupl:[12,14],turn:14,tutori:15,two:[6,13,14],type:[7,12,13,14,16],uniqu:15,unit:[12,13,16],unknown:12,unnormalis:14,unoccupi:16,until:16,unweight:6,updat:9,upon:[13,14],upper:12,upper_limit:12,use:[2,4,6,7,8,9],used:[5,6,9,12,14,16],useful:[5,16],user:[0,16],uses:5,using:[0,5,7,9,11,12,16],usinhag:12,valenc:[5,12,14,16],valence_band:12,valid:12,valu:[9,12,16],variou:[0,12,15],vasp:[0,5,10,12,16],vasppi:[0,3,5,9,16],vbm:[13,14,16],vbm_index:13,vector:[14,16],version:[7,11],via:4,visualis:[5,9],volum:13,w_i:6,wai:7,walk:5,walsh:1,warn:12,warranti:8,weight:[6,12,16],weight_integr:12,weighted_leastsq_effmass:12,weighted_leastsq_fit:12,welcom:[4,10],whallei:[1,2,3,8,15],when:[12,14,16],where:[6,12,13,14,16],whether:8,which:[0,4,5,12,13,14,15,16],who:[5,9],whole:12,whom:8,within:[0,5,14],withing:12,without:[8,16],work:[],would:[4,12,13],written:[1,9],you:[2,4,5,7,9,16],your:[2,5,7,9,16],zero:[12,16],zone:5},titles:["API documentation","Acknowledgements","Citing","Contributors","Development","Features","Implementation","Installation","License","Related packages","Supported Codes","Testing","effmass.analysis","effmass.dos","effmass.extrema","Effmass","effmass.inputs","effmass.outputs"],titleterms:{acknowledg:1,analysi:12,api:0,calcul:6,cite:2,code:10,contributor:3,curvatur:6,detail:15,develop:4,document:[0,15],dos:13,effect:6,effmass:[9,12,13,14,15,16,17],extrema:14,featur:[5,9],implement:6,input:16,instal:7,licens:8,mass:6,method:6,output:17,packag:9,relat:9,support:10,test:11,uniqu:9,which:9}})