Files
kaipy/docs/source/scripts.rst
2025-06-18 13:07:46 -06:00

190 lines
5.1 KiB
ReStructuredText

Command Line Scripts
================================================
Quicklook
------------------------------------------------
The quicklook directory has scripts that are used to quickly look at the data. The scripts are written in python and use the matplotlib library to plot the data. The scripts are:
.. .. autoprogram:: dbpic:create_command_line_parser()
:prog: dbpic.py
.. autoprogram:: dbVid:create_command_line_parser()
:prog: dbVid
.. autoprogram:: dstpic:create_command_line_parser()
:prog: dstpic
.. autoprogram:: gamerrpic:create_command_line_parser()
:prog: gamerrpic
.. autoprogram:: gamerrVid:create_command_line_parser()
:prog: gamerrVid
.. autoprogram:: gamsphVid:create_command_line_parser()
:prog: gamsphVid
.. autoprogram:: heliomovie:create_command_line_parser()
:prog: heliomovie
.. autoprogram:: heliopic:create_command_line_parser()
:prog: heliopic
.. autoprogram:: mixpic:create_command_line_parser()
:prog: mixpic
.. autoprogram:: msphpic:create_command_line_parser()
:prog: msphpic
.. autoprogram:: raijupic:create_command_line_parser()
:prog: raijupic
.. autoprogram:: rcmDataProbe:create_command_line_parser()
:prog: rcmDataProbe
.. autoprogram:: rcmpic:create_command_line_parser()
:prog: rcmpic
.. autoprogram:: remixTimeSeries:create_command_line_parser()
:prog: remixTimeSeries
.. autoprogram:: swpic:create_command_line_parser()
:prog: swpic
.. autoprogram:: vizTrj:create_command_line_parser()
:prog: vizTrj
Preprocessing
------------------------------------------------
The preprocessing directory has scripts that are used to setup MAGE simulations including grid generation and solar wind input file. The scripts are:
.. autoprogram:: cda2wind:create_command_line_parser()
:prog: cda2wind
.. autoprogram:: genLFM:create_command_line_parser()
:prog: genLFM
.. autoprogram:: genRCM:create_command_line_parser()
:prog: genRCM
.. autoprogram:: genRAIJU:create_command_line_parser()
:prog: genRAIJU
.. .. autoprogram:: INIGenerator:parse_args()
:prog: INIGenerator.py
.. autoprogram:: wsa2gamera:create_command_line_parser()
:prog: wsa2gamera
.. autoprogram:: XMLGenerator:create_command_line_parser()
:prog: XMLGenerator
Postprocessing
------------------------------------------------
The postprocessing directory has scripts that are used to process MAGE simulations including data analysis and visualization. The scripts are:
.. .. autoprogram:: block_genmpiXDMF:create_command_line_parser()
:prog: block_genmpiXDMF.py
.. autoprogram:: embiggen:create_command_line_parser()
:prog: embiggen
.. autoprogram:: embiggenMIX:create_command_line_parser()
:prog: embiggenMIX
.. autoprogram:: embiggenRCM:create_command_line_parser()
:prog: embiggenRCM
.. autoprogram:: embiggenVOLT:create_command_line_parser()
:prog: embiggenVOLT
.. autoprogram:: genmpiXDMF:create_command_line_parser()
:prog: genmpiXDMF
.. autoprogram:: genXDMF:create_command_line_parser()
:prog: genXDMF
.. autoprogram:: genXLine:create_command_line_parser()
:prog: genXLine
.. autoprogram:: numSteps:create_command_line_parser()
:prog: numSteps
.. autoprogram:: pitmerge:create_command_line_parser()
:prog: pitmerge
.. autoprogram:: printResTimes:create_command_line_parser()
:prog: printResTimes
.. autoprogram:: run_calcdb:create_command_line_parser()
:prog: run_calcdb
.. autoprogram:: run_ground_deltaB_analysis:create_command_line_parser()
:prog: run_ground_deltaB_analysis
.. autoprogram:: slimFL:create_command_line_parser()
:prog: slimFL
.. autoprogram:: slimh5:create_command_line_parser()
:prog: slimh5
.. autoprogram:: slimh5_classic:create_command_line_parser()
:prog: slimh5_classic
.. autoprogram:: supermag_comparison:create_command_line_parser()
:prog: supermag_comparison
.. autoprogram:: supermage_analysis:create_command_line_parser()
:prog: supermage_analysis
.. autoprogram:: ut2mjd:create_command_line_parser()
:prog: ut2mjd
Datamodel
------------------------------------------------
The datamodel directory scripts are:
.. .. autoprogram:: helioSatComp:create_command_line_parser()
:prog: helioSatComp.py
.. autoprogram:: msphParallelSatComp:create_command_line_parser()
:prog: msphParallelSatComp
.. autoprogram:: msphPbsSatComp:create_command_line_parser()
:prog: msphPbsSatComp
.. autoprogram:: msphSatComp:create_command_line_parser()
:prog: msphSatComp
.. autoprogram:: rbspSCcomp:create_command_line_parser()
:prog: rbspSCcomp
.. .. autoprogram:: rcm_rbsp_satcomp:create_command_line_parser()
:prog: rcm_rbsp_satcomp.py
OHelio
------------------------------------------------
The OHelio directory scripts are:
.. autoprogram:: ih2oh:create_command_line_parser()
:prog: ih2oh
Raiju
------------------------------------------------
Raiju directory scripts are:
.. autoprogram:: kaipy.raiju.dst:create_command_line_parser()
:prog: raijudst
.. autoprogram:: kaipy.raiju.m2m:create_command_line_parser()
:prog: raijum2m