Kaipy documentation!

Kaipy is a Python package for analysis and visualization of simulation results from a scientific software package Kaiju. Kaiju includes the Multiscale Atmosphere-Geospace Environment (MAGE) model developed by the NASA DRIVE Center for Geospace Storms as well as other scientific software for simulation of heliospheric environments such as planetary magnetospheres and the solar wind.

Kaipy:

• Installation
  • Conda Installation
  • Creating Environment
  • Installing kaipy
• Requirements
• Usage
  • Kaipy API Package
    • Loading datasets
    • Plots
  • Kaipy Command Line Interface
    • msphpic.py
    • mixpic.py
• Command Line Scripts
  • Quicklook
    • dbVid
    • dstpic
    • gamerrpic
    • gamerrVid
    • gamsphVid
    • heliomovie
    • heliopic
    • mixpic
    • msphpic
    • raijupic
    • rcmDataProbe
    • rcmpic
    • remixTimeSeries
    • swpic
    • vizTrj
  • Preprocessing
    • cda2wind
    • genLFM
    • genRCM
    • genRAIJU
    • wsa2gamera
    • XMLGenerator
  • Postprocessing
    • embiggen
    • embiggenMIX
    • embiggenRCM
    • embiggenVOLT
    • genmpiXDMF
    • genXDMF
    • genXLine
    • numSteps
    • pitmerge
    • printResTimes
    • run_calcdb
    • run_ground_deltaB_analysis
    • slimFL
    • slimh5
    • slimh5_classic
    • supermag_comparison
    • supermage_analysis
    • ut2mjd
  • Datamodel
    • msphParallelSatComp
    • msphPbsSatComp
    • msphSatComp
    • rbspSCcomp
  • OHelio
    • ih2oh
  • Raiju
    • raijudst
    • raijum2m
• Kaipy Package API Index
  • Kaipy Package
    • kaipy.cdaweb_utils module
      • fetch_helio_spacecraft_HGS_trajectory()
      • fetch_helio_spacecraft_trajectory()
      • fetch_satellite_SM_position()
      • fetch_satellite_geographic_position()
      • fetch_satellite_magnetic_northern_footprint_position()
      • fetch_satellite_magnetic_southern_footprint_position()
      • fetch_spacecraft_SM_trajectory()
      • ingest_helio_spacecraft_trajectory()
    • kaipy.embiggenUtils module
      • Bvec2Global()
      • CompRestarts()
      • Corner2Global()
      • Flux2Global()
      • Gas2Global()
      • MaxDiv()
      • PullRestartMPI()
      • PushRestartMPI()
      • Volume()
      • ccL2G()
      • upCCMag()
      • upFlux()
      • upGas()
      • upGrid()
      • upVarCC()
    • kaipy.kJobs module
      • OMPJob()
      • addXBlk()
      • genXBlk()
      • xml2str()
    • kaipy.kaiH5 module
      • CheckDirOrMake()
      • CheckOrDie()
      • GetBranch()
      • GetHash()
      • H5Info
      • LocDT()
      • MageStep()
      • PullAtt()
      • PullVar()
      • PullVarLoc()
      • StampBranch()
      • StampHash()
      • TPInfo
      • cntSteps()
      • cntX()
      • genName()
      • genNameOld()
      • getDims()
      • getRootVars()
      • getTs()
      • getVars()
      • tStep()
    • kaipy.kaiTools module
      • GetSymH()
      • L_to_bVol()
      • MJD2UT()
      • burtonDst()
      • dipoleL()
      • dipoleShift()
      • getRunInfo()
      • interpTSC()
      • interpTSCWeights()
      • newellcoupling()
      • newellkp()
      • pntIdx_2D()
      • rtp2rt()
      • to_center1D()
      • to_center2D()
      • to_center3D()
      • utIdx()
      • xyz2rtp()
    • kaipy.kaiViz module
      • DrawCut()
      • MidpointNormalize
      • SetAx()
      • SetAxDate()
      • SetAxLabs()
      • ShaveX()
      • ShaveY()
      • addEarth2D()
      • compPlot()
      • genCB()
      • genNorm()
      • get_aspect()
      • helioCompPlot_new()
      • helioItemPlot_new()
      • helioTrajPlot()
      • helio_labelStr()
      • itemPlot()
      • labelStr()
      • picSz()
      • reWrap()
      • savePic()
      • setBndsByAspect()
      • trajPlot()
      • trimFig()
    • kaipy.kaijson module
      • CustomEncoder
      • customhook()
      • dump()
      • dumps()
      • load()
      • loads()
    • kaipy.kaixdmf module
      • AddDI()
      • AddData()
      • AddGrid()
      • AddVectors()
      • addHyperslab()
      • getLoc()
      • getRootVars()
      • getVars()
      • printVidAndLocs()
    • kaipy.kdefs module
    • kaipy.supermage module
      • CalculateSMRBins()
      • EField1DCalculation()
      • E_Field_1D()
      • FetchSMData()
      • FetchSMIndices()
      • Float2Time()
      • InterpolateSimData()
      • MJD2Str()
      • MakeContourPlots()
      • MakeIndicesPlot()
      • ReadSimData()
      • SMContourPlotPrep()
      • SMdict_to_df()
      • Time2Float()
      • Z_Tensor_1D()
      • doFetch()
      • interp_grid()
      • interp_tri()
    • kaipy.transform module
      • GSEtoGSM()
      • GSMtoSM()
      • SMtoGSM()
  • Chimp Package
    • kaipy.chimp.chimph5p module
      • bndTPs()
      • cntTPs()
      • getH5p()
      • getH5pT()
      • getH5pid()
      • locPID()
    • kaipy.chimp.chimpviz module
      • AddTPs()
    • kaipy.chimp.kCyl module
      • PIso()
      • getEQGrid()
      • getGrid()
      • getSlc()
  • Gamera Package
    • kaipy.gamera.deltabViz module
      • CheckLevel()
      • DecorateDBAxis()
      • GenTStr()
      • GenUniformLL()
      • GetCoords()
    • kaipy.gamera.gamGrids module
      • Aug2D()
      • Aug2Dext()
      • Aug3D()
      • Egglipses()
      • GenKSph()
      • GenKSphNonU()
      • GenKSphNonUGL()
      • LoadTabG()
      • PrintRing()
      • RampUp()
      • VizGrid()
      • WriteChimp()
      • WriteGrid()
      • genEgg()
      • genEllip()
      • genFatEgg()
      • genRing()
      • genSph()
      • regrid()
    • kaipy.gamera.gampp module
      • GameraPipe
    • kaipy.gamera.magsphere module
      • GamsphPipe
    • kaipy.gamera.magsphereRescale module
      • MaxDiv()
      • PullRestartMPI()
      • PushRestartMPI()
      • Volume()
      • downFlux()
      • downGas()
      • downGrid()
      • downMIX()
      • downVolt()
      • upFlux()
      • upGas()
      • upGrid()
      • upMIX()
      • upRCM()
      • upRCM1D()
      • upRCM1Dw()
      • upRCMCpl()
      • upVolt()
    • kaipy.gamera.msphViz module
      • AddIonBoxes()
      • AddSizeArgs()
      • CalcTotalErrAbs()
      • CalcTotalErrRel()
      • GetSizeBds()
      • PlotEqB()
      • PlotEqEphi()
      • PlotEqErrAbs()
      • PlotEqErrRel()
      • PlotJyXZ()
      • PlotLogicalErrAbs()
      • PlotLogicalErrRel()
      • PlotMPI()
      • PlotMerid()
      • plotPlane()
      • plotXY()
      • plotXZ()
    • kaipy.gamera.rcmpp module
      • AddRCMBox()
      • GetMask()
      • GetPotential()
      • GetVarMask()
      • RCMEq()
      • RCMInset()
    • kaipy.gamera.remixpp module
      • AddCBs()
      • AddPotCB()
      • CMIPic()
  • Gamhelio Package
    • Primary Package
      • kaipy.gamhelio.helioViz module
      • kaipy.gamhelio.heliosphere module
    • Lib Package
      • kaipy.gamhelio.lib.wsa module
    • wsa2gamera Package
      • kaipy.gamhelio.wsa2gamera.params module
  • Paraview Package
    • kaipy.paraview.pvGam module
    • kaipy.paraview.pvutils module
  • RCM Package
    • Primary Package
      • kaipy.rcm.rcminit module
      • kaipy.rcm.rcmutils module
      • kaipy.rcm.rcmxdmf module
    • Lambdautils Package
      • kaipy.rcm.lambdautils.AlamData module
      • kaipy.rcm.lambdautils.AlamParams module
      • kaipy.rcm.lambdautils.DistTypes module
      • kaipy.rcm.lambdautils.fileIO module
      • kaipy.rcm.lambdautils.genAlam module
      • kaipy.rcm.lambdautils.plotter module
    • Wmutils Package
      • kaipy.rcm.wmutils.genWM module
      • kaipy.rcm.wmutils.wmData module
  • Raiju Package
    • Primary Package
      • kaipy.raiju.dst module
      • kaipy.raiju.m2m module
      • kaipy.raiju.raijuUtils module
    • Lambdautils Package
      • kaipy.raiju.lambdautils.AlamData module
      • kaipy.raiju.lambdautils.AlamParams module
      • kaipy.raiju.lambdautils.DistTypes module
      • kaipy.raiju.lambdautils.fileIO module
    • waveModel Package
      • kaipy.raiju.waveModel.genWM module
      • kaipy.raiju.waveModel.wmData module
  • Remix Package
    • kaipy.remix.remix module
      • remix
  • Satcomp Package
    • kaipy.satcomp.scRCM module
      • consolidateODFs()
      • genRCMTrack_jfname()
      • genSCD_jfname()
      • genVarNorm()
      • getIntensitiesVsL()
      • getRCM_CumulFrac()
      • getRCM_eqlatlon()
      • getRCM_scTrack()
      • getRCMtimes()
      • getSCOmniDiffFlux()
      • getSpecieslambdata()
      • getVarCube()
      • getVarWedge()
      • get_aspect()
      • plt_ODF_Comp()
      • plt_rcm_eqlatlon()
      • plt_tl()
      • to_center()
    • kaipy.satcomp.scutils module
      • addFileToMerge()
      • addGAMERA()
      • addVar()
      • computeErrors()
      • convertGameraVec()
      • copy_attributes()
      • createInputFiles()
      • createMergeFile()
      • create_sctrack_helio_input_files()
      • create_sctrack_helio_trajectory_file()
      • create_sctrack_helio_xml()
      • errorReport()
      • extractGAMERA()
      • genSCXML()
      • genSatCompLockScript()
      • genSatCompPbsScript()
      • getCdasDsetInterval()
      • getJScl()
      • getSatData()
      • getScIds()
      • getWeights_ConsArea()
      • get_helio_cdaweb_data()
      • helio_addVar()
      • helio_pullVar()
      • ingest_cdaweb_density()
      • ingest_cdaweb_ephemeris()
      • ingest_cdaweb_magnetic_field()
      • ingest_cdaweb_speed()
      • ingest_cdaweb_temperature()
      • ingest_helio_cdaweb_data()
      • ingest_interpolated_inDomain()
      • ingest_interpolated_number_density()
      • ingest_interpolated_radial_magnetic_field()
      • ingest_interpolated_radial_velocity()
      • ingest_interpolated_temperature()
      • ingest_interpolated_variables()
      • interpolate_gamhelio_results_to_trajectory()
      • matchUnits()
      • mergeFiles()
      • pullVar()
      • read_MJDc()
      • trilinterp()
      • varMap_1D()
      • write_helio_error_report()
      • xyz_to_L()
  • SolarWind Package
    • kaipy.solarWind.OMNI module
      • OMNI
      • OMNIW
      • main()
    • kaipy.solarWind.SolarWind module
      • SolarWind
    • kaipy.solarWind.TimeSeries module
      • TimeSeries
      • main()
    • kaipy.solarWind.WIND module
      • WIND
      • main()
    • kaipy.solarWind.swBCplots module
      • BasicPlot()
      • MultiPlot()
      • MultiPlot2()
      • MultiPlotN()
      • SummaryPlot()
      • swQuickPlot()
• Developers
  • Clone repository
  • Install Editable Kaipy

Indices and tables

• Index

• Module Index

• Search Page