MMS cribs: Difference between revisions

From SPEDAS Wiki
Jump to navigation Jump to search
(adding cribs list)
 
 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
This page describes [[MMS|MMS]] cribs.  These are generally IDL main scripts that contain example usage of MMS related routines.  See also [[SPEDAS_cribs|SPEDAS cribs]] for general purpose crib sheets and [[crib_sheets|crib sheets]] for an index of all our crib sheet pages.
SPEDAS contains several crib sheets that show how to use the various [[MMS|MMS]] load routines and analysis tools.  See also [[SPEDAS_cribs|SPEDAS cribs]] for general purpose crib sheets (SPEDAS tools, tplot, etc.) and [[crib_sheets|crib sheets]] for an index of all our crib sheet pages.


== basic/introductory cribs ==
== Basic crib sheets ==
Basic crib sheets are meant to be used by users new to the MMS SPEDAS plugin.


* '''mms_basic_dayside.pro''' -- Basic dayside science overview plots
The following crib sheets can be found in the SPEDAS distribution at:
* '''mms_cotrans_crib.pro''' -- Coordinate transforms between spacecraft and geophysical coordinate systems.
 
* '''mms_crib_stel3d.pro''' -- Use FPI and HPCA data with STEL3D visualization tool
 
* '''mms_feeps_sectspec_crib.pro''' -- Create FEEPS spectrograms for checking sunlight masking effectiveness.
projects/mms/examples/basic/
* '''mms_fields_crib_qlplots.pro''' -- Quicklook plots of various fields data.
 
* '''mms_formation_crib.pro''' -- Create 3D plots of instantaneous spacecraft formation
 
* '''mms_burst_status_crib.pro''' -- Display availability of burst data
* '''mms_cotrans_crib.pro''' -- Coordinate transforms between spacecraft and geophysical coordinate systems
* '''mms_qcotrans_crib.pro''' -- Coordinate transforms between spacecraft and geophysical coordinate systems using quaternions in the MEC files
* '''mms_feeps_sectspec_crib.pro''' -- Create FEEPS spectrograms for checking sunlight masking effectiveness
* '''mms_find_burst_intervals_crib.pro''' -- Use burst interval bar to find MMS burst intervals (start/stop times)
* '''mms_formation_crib.pro''' -- Create 3D plots of the spacecraft formation
* '''mms_load_aspoc_crib.pro''' -- Active Spacecraft Potential Control (ASPOC) data products
* '''mms_load_aspoc_crib.pro''' -- Active Spacecraft Potential Control (ASPOC) data products
* '''mms_load_dsp_crib.pro''' -- Digital Signal Processing (DSP) Board products
* '''mms_load_dsp_crib.pro''' -- Digital Signal Processing (DSP) Board products
Line 15: Line 22:
* '''mms_load_eis_burst_crib.pro''' -- Energetic Ion Spectrometer (EIS) burst data products
* '''mms_load_eis_burst_crib.pro''' -- Energetic Ion Spectrometer (EIS) burst data products
* '''mms_load_eis_crib.pro''' -- General EIS data products
* '''mms_load_eis_crib.pro''' -- General EIS data products
* '''mms_load_eis_crib_qlplots.pro''' -- EIS quicklook products
* '''mms_load_feeps-eis_crib_qlplots.pro''' -- Combined FEEPS / EIS plots
* '''mms_load_feeps_crib.pro''' -- General Fly's Eye Energetic Particle Sensor (FEEPS) products
* '''mms_load_feeps_crib.pro''' -- General Fly's Eye Energetic Particle Sensor (FEEPS) products
* '''mms_load_feeps_crib_qlplots.pro''' -- FEEPS quicklook products
* '''mms_load_fgm_burst_crib.pro''' -- Fluxgate Magnetometer burst data products
* '''mms_load_fgm_burst_crib.pro''' -- Fluxgate Magnetometer burst data products (Analog (AFG) & Digital (DFG))
* '''mms_load_fgm_crib.pro''' -- General Fluxgate Magnetometer products
* '''mms_load_fgm_crib.pro''' -- General Fluxgate Magnetometer products (AFG & DFG)
* '''mms_load_fpi_burst_crib.pro''' -- Fast Plasma Instrument (FPI) burst data products
* '''mms_load_fpi_burst_crib.pro''' -- Fast Plasma Instrument (FPI) burst data products
* '''mms_load_fpi_crib.pro''' -- General FPI products
* '''mms_load_fpi_crib.pro''' -- General FPI products
* '''mms_load_fpi_crib_qlplots.pro''' -- FPI quicklook products
* '''mms_load_fpi_crib_qlplots_l2.pro''' -- Level 2 FPI quicklook products
* '''mms_load_hpca_burst_crib.pro''' -- Hot Plasma Composition Analyzer (HPCA) burst data products
* '''mms_load_hpca_burst_crib.pro''' -- Hot Plasma Composition Analyzer (HPCA) burst data products
* '''mms_load_hpca_crib.pro''' -- General HPCA data products
* '''mms_load_hpca_crib.pro''' -- General HPCA data products
* '''mms_load_hpca_crib_qlplots.pro''' -- Hot HPCA quicklook products
* '''mms_load_scm_crib.pro''' -- Search coil magnetometer data
* '''mms_load_scm_crib.pro''' -- Search coil magnetometer data
* '''mms_load_state_crib.pro''' -- Ephemeris and attitude data  
* '''mms_load_state_crib.pro''' -- Ephemeris and attitude data  
* '''mms_part_products_crib.pro''' -- Moments and spectrograms derived from FPI and HPCA particle distributions
* '''mms_plasma_beta_crib.pro''' -- Calculate plasma beta using density, temperature from FPI and the B-field from FGM
* '''mms_version_numbers_crib.pro''' -- Add MMS CDF version numbers to plots
* '''mms_fpi_angle_angle_crib.pro''' -- Create FPI angle-angle plots from the distribution function data
* '''mms_eis_angle_angle_crib.pro''' -- Create EIS angle-angle plots
* '''mms_curlometer_crib.pro''' -- Calculate various curlometer products using mms_curl and mms_lingradest
* '''mms_error_bars_crib.pro''' -- Example of how to create a plot of FPI density with error bars
* '''mms_load_fsm_crib.pro''' -- L3 merged FGM + SCM data products
* '''mms_orbit_crib.pro''' -- Example of creating MMS orbits plots
 
 
== Advanced crib sheets ==
SPEDAS also contains scripts that show more advanced usage of the MMS plugin, as well as scripts that generate multi-instrument/science quality (L2) figures; these scripts can be found in the folder:
 
 
projects/mms/examples/advanced/
 
 
* '''mms_flipbook_crib.pro''' -- Create a flipbook-style series of images (or video) of your current tplot window with 2D and 1D FPI or HPCA distribution slices
* '''mms_basic_dayside.pro''' -- Basic dayside science overview plots
* '''mms_basic_tail.pro''' -- Basic tail science overview plots
* '''mms_isee_3d_crib.pro''' -- Use FPI and HPCA data with ISEE 3D visualization tool
* '''mms_fpi_dist_slice_comparison_crib.pro''' -- 2D FPI distribution slices - multiple per figure
* '''mms_load_fpi_summary_crib.pro''' -- Level 2 FPI summary figures
* '''mms_multi_axis.pro''' -- Create a figure with multiple panels, one of which has 2 different data products (one using left axis and one using right axis)
* '''mms_mva_crib.pro''' -- Shows how to transform tplot variables into minimum variance analysis coordinates
* '''mms_neutral_sheet_crib.pro''' -- Shows how to load MMS position data and retrieve the distance from the S/C to the neutral sheet
* '''mms_part_getspec_crib.pro''' -- Moments and spectrograms derived from FPI and HPCA particle distributions
* '''mms_slice2d_fpi_crib.pro''' -- 2D slices of FPI particle distributions
* '''mms_slice2d_fpi_crib.pro''' -- 2D slices of FPI particle distributions
* '''mms_slice2d_hpca_crib.pro''' -- 2D slices of HPCA particle distributions
* '''mms_slice2d_hpca_crib.pro''' -- 2D slices of HPCA particle distributions
* '''spd_mms_load_bss_crib.pro''' -- Display availability of burst data.
* '''mms_wavpol_crib.pro''' -- Crib sheet demonstrating usage of the wave polarization routines using MMS SCM data
* '''crib_ebv_compare.pro''' --  
* '''mms_hpca_eis_combined_crib.pro''' -- Example showing how to combine multiple spectra variables into a single tplot panel
* '''crib_read_burst_fpi_dfg.pro''' --  
* '''mms_plot3d_fpi_crib.pro''' -- Example showing how to use FPI distribution data with older SPEDAS particle routines
* '''crib_read_burst_fpi_dfg_multi.pro''' --  
* '''mms_poynting_flux_crib.pro''' -- Example showing how to calculate Poynting flux
* '''crib_read_survey_fpi_dfg.pro''' --
* '''mms_slice2d_1d_plot_crib.pro''' -- Calculate 1D spectra through 2D slices produced by spd_slice2d
* '''mms_tplot2autoplot_crib.pro''' -- Example showing how to send tplot variables to Autoplot
* '''mms_tplot2cdf_crib.pro''' - Example showing how to save tplot data to a CDF file
* '''crib_master/crib_master_v5.pro''' -- Crib sheet demonstrating multi-instrument figure
 
== Quicklook crib sheets ==
SPEDAS also contains scripts that use the MMS quicklook (QL) data to make QL figures; these scripts load and plot QL/L1b data (non-science quality), and require MMS team member access to the LASP SDC.
 
Users should use Quicklook data plots for event browsing, and not for scientific analysis or publication without express consent of the PI and relevant Lead Co-Investigators.
 
projects/mms/examples/quicklook/
 
 
* '''mms_basic_dayside_qlplots.pro''' -- MMS basic dayside figure, using QL data
* '''mms_fields_crib_qlplots.pro''' -- Quicklook plots of various fields data
* '''mms_load_eis_crib_qlplots.pro''' -- EIS quicklook figure
* '''mms_load_eis_pad_crib_qlplots.pro''' -- EIS pitch angle distribution quicklook figure
* '''mms_load_feeps_crib_qlplots.pro''' -- FEEPS quicklook figure
* '''mms_load_feeps-eis_crib_qlplots.pro''' -- Combined FEEPS / EIS plots
* '''mms_load_fpi_crib_qlplots.pro''' -- FPI quicklook figures
* '''mms_load_hpca_crib_qlplots.pro''' -- HPCA quicklook figure that includes spectra
* '''mms_load_hpca_summary_qlplots.pro''' -- HPCA quicklook figure that includes moments data
 
 
 
== Webinars ==
The webinars folder, located at:
 
projects/mms/examples/webinars/
 
contains scripts used to demonstrate various SPEDAS features on webinars held by the SPEDAS team
 
 
* '''mms_particle_webinar_28sep16.pro''' -- Particles webinar held on 28 September 2016
* '''eis_feeps_webinar_26oct16.pro''' -- EIS/FEEPS webinar held on 26 October 2016
* '''mms_spedas_2aug17.pro''' -- General MMS webinar held on 2 August 2017
* '''mms_plasma_webinar_15nov17.pro''' -- Plasma instruments (FPI/HPCA) webinar held on 15 November 2017
* '''mms_fields_webinar_14feb18.pro''' -- FIELDS webinar held on 14 February 2018
 
Note: the webinar scripts may be out of date.

Latest revision as of 20:33, 29 March 2018

SPEDAS contains several crib sheets that show how to use the various MMS load routines and analysis tools. See also SPEDAS cribs for general purpose crib sheets (SPEDAS tools, tplot, etc.) and crib sheets for an index of all our crib sheet pages.

Basic crib sheets

Basic crib sheets are meant to be used by users new to the MMS SPEDAS plugin.

The following crib sheets can be found in the SPEDAS distribution at:


projects/mms/examples/basic/


  • mms_burst_status_crib.pro -- Display availability of burst data
  • mms_cotrans_crib.pro -- Coordinate transforms between spacecraft and geophysical coordinate systems
  • mms_qcotrans_crib.pro -- Coordinate transforms between spacecraft and geophysical coordinate systems using quaternions in the MEC files
  • mms_feeps_sectspec_crib.pro -- Create FEEPS spectrograms for checking sunlight masking effectiveness
  • mms_find_burst_intervals_crib.pro -- Use burst interval bar to find MMS burst intervals (start/stop times)
  • mms_formation_crib.pro -- Create 3D plots of the spacecraft formation
  • mms_load_aspoc_crib.pro -- Active Spacecraft Potential Control (ASPOC) data products
  • mms_load_dsp_crib.pro -- Digital Signal Processing (DSP) Board products
  • mms_load_edi_crib.pro -- Electron Drift Instrument (EDI) data products
  • mms_load_edp_crib.pro -- Electric Field Double Probe (EDP) data products
  • mms_load_eis_burst_crib.pro -- Energetic Ion Spectrometer (EIS) burst data products
  • mms_load_eis_crib.pro -- General EIS data products
  • mms_load_feeps_crib.pro -- General Fly's Eye Energetic Particle Sensor (FEEPS) products
  • mms_load_fgm_burst_crib.pro -- Fluxgate Magnetometer burst data products
  • mms_load_fgm_crib.pro -- General Fluxgate Magnetometer products
  • mms_load_fpi_burst_crib.pro -- Fast Plasma Instrument (FPI) burst data products
  • mms_load_fpi_crib.pro -- General FPI products
  • mms_load_hpca_burst_crib.pro -- Hot Plasma Composition Analyzer (HPCA) burst data products
  • mms_load_hpca_crib.pro -- General HPCA data products
  • mms_load_scm_crib.pro -- Search coil magnetometer data
  • mms_load_state_crib.pro -- Ephemeris and attitude data
  • mms_plasma_beta_crib.pro -- Calculate plasma beta using density, temperature from FPI and the B-field from FGM
  • mms_version_numbers_crib.pro -- Add MMS CDF version numbers to plots
  • mms_fpi_angle_angle_crib.pro -- Create FPI angle-angle plots from the distribution function data
  • mms_eis_angle_angle_crib.pro -- Create EIS angle-angle plots
  • mms_curlometer_crib.pro -- Calculate various curlometer products using mms_curl and mms_lingradest
  • mms_error_bars_crib.pro -- Example of how to create a plot of FPI density with error bars
  • mms_load_fsm_crib.pro -- L3 merged FGM + SCM data products
  • mms_orbit_crib.pro -- Example of creating MMS orbits plots


Advanced crib sheets

SPEDAS also contains scripts that show more advanced usage of the MMS plugin, as well as scripts that generate multi-instrument/science quality (L2) figures; these scripts can be found in the folder:


projects/mms/examples/advanced/


  • mms_flipbook_crib.pro -- Create a flipbook-style series of images (or video) of your current tplot window with 2D and 1D FPI or HPCA distribution slices
  • mms_basic_dayside.pro -- Basic dayside science overview plots
  • mms_basic_tail.pro -- Basic tail science overview plots
  • mms_isee_3d_crib.pro -- Use FPI and HPCA data with ISEE 3D visualization tool
  • mms_fpi_dist_slice_comparison_crib.pro -- 2D FPI distribution slices - multiple per figure
  • mms_load_fpi_summary_crib.pro -- Level 2 FPI summary figures
  • mms_multi_axis.pro -- Create a figure with multiple panels, one of which has 2 different data products (one using left axis and one using right axis)
  • mms_mva_crib.pro -- Shows how to transform tplot variables into minimum variance analysis coordinates
  • mms_neutral_sheet_crib.pro -- Shows how to load MMS position data and retrieve the distance from the S/C to the neutral sheet
  • mms_part_getspec_crib.pro -- Moments and spectrograms derived from FPI and HPCA particle distributions
  • mms_slice2d_fpi_crib.pro -- 2D slices of FPI particle distributions
  • mms_slice2d_hpca_crib.pro -- 2D slices of HPCA particle distributions
  • mms_wavpol_crib.pro -- Crib sheet demonstrating usage of the wave polarization routines using MMS SCM data
  • mms_hpca_eis_combined_crib.pro -- Example showing how to combine multiple spectra variables into a single tplot panel
  • mms_plot3d_fpi_crib.pro -- Example showing how to use FPI distribution data with older SPEDAS particle routines
  • mms_poynting_flux_crib.pro -- Example showing how to calculate Poynting flux
  • mms_slice2d_1d_plot_crib.pro -- Calculate 1D spectra through 2D slices produced by spd_slice2d
  • mms_tplot2autoplot_crib.pro -- Example showing how to send tplot variables to Autoplot
  • mms_tplot2cdf_crib.pro - Example showing how to save tplot data to a CDF file
  • crib_master/crib_master_v5.pro -- Crib sheet demonstrating multi-instrument figure

Quicklook crib sheets

SPEDAS also contains scripts that use the MMS quicklook (QL) data to make QL figures; these scripts load and plot QL/L1b data (non-science quality), and require MMS team member access to the LASP SDC.

Users should use Quicklook data plots for event browsing, and not for scientific analysis or publication without express consent of the PI and relevant Lead Co-Investigators.

projects/mms/examples/quicklook/


  • mms_basic_dayside_qlplots.pro -- MMS basic dayside figure, using QL data
  • mms_fields_crib_qlplots.pro -- Quicklook plots of various fields data
  • mms_load_eis_crib_qlplots.pro -- EIS quicklook figure
  • mms_load_eis_pad_crib_qlplots.pro -- EIS pitch angle distribution quicklook figure
  • mms_load_feeps_crib_qlplots.pro -- FEEPS quicklook figure
  • mms_load_feeps-eis_crib_qlplots.pro -- Combined FEEPS / EIS plots
  • mms_load_fpi_crib_qlplots.pro -- FPI quicklook figures
  • mms_load_hpca_crib_qlplots.pro -- HPCA quicklook figure that includes spectra
  • mms_load_hpca_summary_qlplots.pro -- HPCA quicklook figure that includes moments data


Webinars

The webinars folder, located at:

projects/mms/examples/webinars/

contains scripts used to demonstrate various SPEDAS features on webinars held by the SPEDAS team


  • mms_particle_webinar_28sep16.pro -- Particles webinar held on 28 September 2016
  • eis_feeps_webinar_26oct16.pro -- EIS/FEEPS webinar held on 26 October 2016
  • mms_spedas_2aug17.pro -- General MMS webinar held on 2 August 2017
  • mms_plasma_webinar_15nov17.pro -- Plasma instruments (FPI/HPCA) webinar held on 15 November 2017
  • mms_fields_webinar_14feb18.pro -- FIELDS webinar held on 14 February 2018

Note: the webinar scripts may be out of date.