Search.setIndex({docnames:["index","modules","pychi"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.index":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["index.rst","modules.rst","pychi.rst"],objects:{"":{pychi:[2,0,0,"-"]},"pychi.light":{Arbitrary:[2,1,1,""],Cw:[2,1,1,""],Gaussian:[2,1,1,""],Light:[2,1,1,""],Sech:[2,1,1,""]},"pychi.light.Light":{add_shot_noise:[2,2,1,""],plot_propagation:[2,2,1,""],set_result_as_start:[2,2,1,""]},"pychi.materials":{Waveguide:[2,1,1,""]},"pychi.materials.Waveguide":{chi_2:[2,2,1,""],chi_3:[2,2,1,""],compute_betas:[2,2,1,""],k:[2,2,1,""],n_eff:[2,2,1,""],plot_refractive_index:[2,2,1,""],rhs_prefactor:[2,2,1,""],set_betas:[2,2,1,""],set_gamma:[2,2,1,""],set_n2:[2,2,1,""]},"pychi.models":{Chi2:[2,1,1,""],Chi2Chi3:[2,1,1,""],Chi3:[2,1,1,""],Model:[2,1,1,""],Spm:[2,1,1,""],SpmChi2:[2,1,1,""],SpmChi2Chi3:[2,1,1,""],SpmChi3:[2,1,1,""],numbaconj:[2,3,1,""],numbacopy:[2,3,1,""],numbaexp:[2,3,1,""]},"pychi.models.Chi2":{nonlinear_term:[2,2,1,""]},"pychi.models.Chi2Chi3":{nonlinear_term:[2,2,1,""]},"pychi.models.Chi3":{nonlinear_term:[2,2,1,""]},"pychi.models.Model":{dispersion_step:[2,2,1,""],nonlinear_term:[2,2,1,""]},"pychi.models.Spm":{nonlinear_term:[2,2,1,""]},"pychi.models.SpmChi2":{nonlinear_term:[2,2,1,""]},"pychi.models.SpmChi2Chi3":{nonlinear_term:[2,2,1,""]},"pychi.models.SpmChi3":{nonlinear_term:[2,2,1,""]},"pychi.solvers":{Solver:[2,1,1,""],numbaexp:[2,3,1,""],numbanorm:[2,3,1,""]},"pychi.solvers.Solver":{solve:[2,2,1,""]},pychi:{light:[2,0,0,"-"],materials:[2,0,0,"-"],models:[2,0,0,"-"],solvers:[2,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"22e":2,"class":2,"default":2,"final":2,"float":2,"function":2,"int":2,"new":2,"return":2,"schr\u00f6dinger":2,Not:2,The:2,accomod:2,accordingli:2,adapt:2,adaptive_factor:2,add:2,add_shot_nois:2,adding:2,affect:2,all:2,allow:2,analyt:2,arbitrari:2,area:2,arrai:2,aug:2,author:2,avail:2,average_pow:2,avoid:2,axes:2,axi:2,base:2,beta:2,built:2,center:2,chi2:2,chi2chi3:2,chi3:2,chi:2,chi_2:2,chi_3:2,child:2,coeffici:2,coher:2,complex:2,comput:2,compute_beta:2,conjug:2,contain:2,content:[0,1],conveni:2,copi:2,creat:2,curv:2,data:2,dedic:2,delai:2,deriv:2,differ:2,dispers:2,dispersion_step:2,domain:2,effect:2,effective_area:2,electr:2,envelop:2,equat:2,evolut:2,exponenti:2,feb:2,field:2,field_f:2,field_t_in:2,first:2,frequenc:2,fri:2,from:2,gamma:2,gaussian:2,gener:2,give:2,given:2,happen:2,harmon:2,here:2,highest:2,implement:2,index:[0,2],inform:2,initi:2,input:2,instanti:2,instead:2,integr:2,interact:2,length:2,light:[0,1],local_error:2,materi:[0,1],max_dz:2,method:2,model:[0,1],modul:[0,1],n_eff:2,nois:2,none:2,nonlinear:2,nonlinear_term:2,note:2,numba:2,numbaconj:2,numbacopi:2,numbaexp:2,numbanorm:2,number:2,object:2,onli:2,optim:2,option:2,order:2,output:2,over:2,overwrit:2,packag:[0,1],page:0,paramet:2,parent:2,phase:2,physic:2,plot:2,plot_propag:2,plot_refractive_index:2,propag:2,properti:2,provid:2,puls:2,pulse_dur:2,pulse_electric_field:2,pulse_energi:2,pulse_frequency_axi:2,pulse_wavelength:2,pychi:1,quantiti:2,raman:2,raman_fract:2,raman_tau_1:2,raman_tau_2:2,random:2,refract:2,relat:2,reproduc:2,result:2,rhs_prefactor:2,save:2,savenam:2,search:0,sech:2,seed:2,self:2,set:2,set_beta:2,set_gamma:2,set_n2:2,set_result_as_start:2,setup:2,shape:2,shot:2,should:2,simul:2,size:2,solv:2,solver:[0,1],sourc:2,specifi:2,spectral:2,spm:2,spmchi2:2,spmchi2chi3:2,spmchi3:2,src:[],standard:2,step:2,store:2,studi:2,submodul:[0,1],suitabl:2,sum:2,support:2,t_pt:2,term:2,thi:2,thibault:2,thu:2,time:2,tripl:2,type:2,use:2,used:2,useful:2,user:2,util:2,valu:2,vector:2,versu:2,voumardt:2,waveform:2,waveguid:2,wavelength:2,which:2,z_pt:2},titles:["Welcome to pychi\u2019s documentation!","&lt;no title&gt;","pychi package"],titleterms:{content:2,document:0,indic:0,light:2,materi:2,model:2,modul:2,packag:2,pychi:[0,2],solver:2,src:[],submodul:2,tabl:0,welcom:0}})