Main Page: Difference between revisions

From SPEDAS Wiki
Jump to navigation Jump to search
(40 intermediate revisions by 5 users not shown)
Line 2: Line 2:
= Welcome to SPEDAS =
= Welcome to SPEDAS =


Here you can find information and documentation for the Space Physics Environment Data Analysis Software (SPEDAS) framework. SPEDAS version 1.00, including version 9.0 of the THEMIS Data Analysis Software (TDAS), and updated
Here you can find information and documentation for the Space Physics Environment Data Analysis Software (SPEDAS) framework. The most current version, SPEDAS 2.00, was released on June 9, 2017.
versions of several other plugins, was released on Aug 29, 2014.


SPEDAS is a grass-roots data analysis software for the Space Physics community. It supports multi-mission data ingestion, analysis and visualization. It standardizes the retrieval of data from distributed repositories, the scientific processing with a powerful set of legacy routines, the quick visualization with full output control and the graph creation for use in papers and presentations.  
SPEDAS is a grass-roots data analysis software for the Space Physics community. It supports multi-mission data ingestion, analysis and visualization. It standardizes the retrieval of data from distributed repositories, the scientific processing with a powerful set of legacy routines, the quick visualization with full output control and the graph creation for use in papers and presentations.  
Line 14: Line 13:
* Can be used with or without an IDL license.   
* Can be used with or without an IDL license.   


SPEDAS supports plugin modules for multiple projects ([[THEMIS]], [[GOES]], WIND, ERG, etc) and provides interfaces for software modules developed by the individual teams of those missions.  
SPEDAS supports plugin modules for multiple projects ([[THEMIS]], [[GOES]], [[MMS]], WIND, ERG, etc) and provides interfaces for software modules developed by the individual teams of those missions.  


SPEDAS is concerned mostly with establishing developers' guidelines, communicating best practices, and providing peer review of new products to like-minded colleagues, towards an efficient space environment data analysis suite of software code.  
SPEDAS is concerned mostly with establishing developers' guidelines, communicating best practices, and providing peer review of new products to like-minded colleagues, towards an efficient space environment data analysis suite of software code.  
<div style="border: 1px solid LightGray; background-color:#FFB2B2; padding: 0px 10px; margin-left: 5px; margin-right: 5px;">
== Known Issues with XQuartz ==
If you're having trouble running the SPEDAS GUI, EVA, or any other code that involves IDL widgets on macOS or OSX, see the [http://spedas.org/wiki/index.php?title=Known_Issues_macOS known issues page for a potential fix].
</div>


== Introduction ==
== Introduction ==


  * [http://www.youtube.com/channel/UCZVyhCNPI3II7Mu086KsoLA SPEDAS Youtube Channel] - SPEDAS introductory videos
  * [http://www.youtube.com/channel/UCZVyhCNPI3II7Mu086KsoLA SPEDAS Youtube Channel] - SPEDAS introductory videos
  * [http://www.youtube.com/watch?v=nXy03dvfcEY&feature=youtu.be Starting with SPEDAS] - Video: how to download and install SPEDAS  
  * [http://www.youtube.com/watch?v=nXy03dvfcEY Starting with SPEDAS] - Video: how to download and install SPEDAS
* [http://www.youtube.com/watch?v=390FguKn7w4 MMS data analysis using SPEDAS: an introduction ] - Video: how to use MMS data with SPEDAS
* [http://www.youtube.com/watch?v=yV2NJeiIQsw MMS multi-instrument plots ] - Video: how to create MMS multi-panel, multi-instrument plots with SPEDAS  
  * [[SPEDAS_Screenshots|SPEDAS Screenshots]] - SPEDAS screenshots
  * [[SPEDAS_Screenshots|SPEDAS Screenshots]] - SPEDAS screenshots
  * [[usage_examples|Introductory Examples]] - Examples for first-time users
  * [[usage_examples|Introductory Examples]] - Examples for first-time users
* [[SPEDAS_Presentations|SPEDAS Presentations]] - PowerPoint presentations on SPEDAS


== Downloads ==
== Downloads and Installation ==
* [[Downloads_and_Installation|<span style="color:red">New! SPEDAS 2.00 released (June 2017)</span>]]
* [http://spedas.org/downloads/spdsw_latest.zip Nightly build] - Quick link to the nightly "bleeding edge" SPEDAS source code zip file. 
* [[Downloads_and_Installation|Downloads and Installation]] - Detailed instructions for downloading and installing SPEDAS.


* [[downloads|Downloads]] - SPEDAS downloads  
The nightly builds are zip files containing a snapshot of the SPEDAS source code repository. They have not been
  * [http://themis.ssl.berkeley.edu/socware/spedas_1_00/idl/ HTML documentation] - Documentation of SPEDAS functions, with source code
through our full QA process, but they do have the very latest features and bug fixes, and this is what many researchers
are using.  
 
The current, fully-QAed version is available from the Downloads and Installation page, in several different formats. In addition to the IDL source code files, this page includes download links to pre-compiled, executable versions of SPEDAS, which do not require a separate, paid, IDL license.


== Supported Missions ==
== Supported Missions ==


* [[THEMIS|THEMIS/ARTEMIS]]
SPEDAS contains specialized plugins that can download, analyze and plot data from multiple space missions, including:
  * [[IUGONET]]
 
  * [[BARREL]]
  * [[ERG]]
  * [[ERG]]
* [[FAST]]
  * [[GOES]]
  * [[GOES]]
* [[IUGONET]]
* [[MMS]]
* [[POES]]
* [[THEMIS|THEMIS/ARTEMIS]]
  * [[WIND]]
  * [[WIND]]
* [[FAST]]


== Documentation ==
== Documentation ==


  * [[installation|Installation]] - SPEDAS installation
  * [http://themis.ssl.berkeley.edu/socware/spedas_1_00/idl/ HTML documentation] - Documentation of SPEDAS functions, with source code and search
  * [[user's_guide|User's Guide]] - Documentation for users
  * [[user's_guide|User's Guide]] - Documentation for users
  * [[developer's_guide|Developer's Guide]] - Documentation for developers
  <!-- * [[developer's_guide|Developer's Guide]] - Documentation for developers -->
  * [[plugin_guide|Plugin Guide]] - Documentation for plugin developers
  * [[plugin_guide|Plugin Guide]] - Documentation for plugin developers
  * [[crib_sheets|Crib Sheets]] - Step-by-step usage scenarios  
  * [[crib_sheets|Crib Sheets]] - Step-by-step usage scenarios  
  * [[tips_and_tricks|Tips and Tricks]] - SPEDAS tips and tricks  
  * [[tips_and_tricks|Tips and Tricks]] - SPEDAS tips and tricks  
  * [[wish_list|Wish List]] - Wish list and roadmap for future development
  <!-- * [[wish_list|Wish List]] - Wish list and roadmap for future development -->
  * [[data_model|Data Model]] - Description of the data model used in SPEDAS
  * [[data_model|Data Model]] - Description of the data model used in SPEDAS
  * [[time_handling|Time Handling]] - Description of how times are used in SPEDAS
  * [[time_handling|Time Handling]] - Description of how times are used in SPEDAS
* [[3D_data_structures|3D Data structures]] - Description of the data structures used in many SPEDAS particle data sets.
* [[3D_data_conversion_factors|3D Data Conversion Factors]] - Description of the conversion factors used for different data quantities, for particle data.


== External Resources ==
== External Resources ==


  * [http://spedas.org/blog/ SPEDAS Blog] - SPEDAS Developer Blog and Announcements  
  * [http://spedas.org/blog/ SPEDAS Blog] - SPEDAS Developer Blog and Announcements  
* [http://spedas.org/changelog/ SPEDAS ChangeLog] - Recent changes to the bleeding edge
  * [http://themis.ssl.berkeley.edu/summary.shtml?autoload=1 Overview Plots] - Summary plots generated with SPEDAS
  * [http://themis.ssl.berkeley.edu/summary.shtml?autoload=1 Overview Plots] - Summary plots generated with SPEDAS
  * [http://www.exelisvis.com/docs/using_idl_home.html IDL Documentation] - IDL Documentation by Exelis
  * [http://www.exelisvis.com/docs/using_idl_home.html IDL Documentation] - IDL Documentation by Exelis
  * [//meta.wikimedia.org/wiki/Help:Contents Wiki User's Guide] - Information on using the wiki software.
  * [//meta.wikimedia.org/wiki/Help:Contents Wiki User's Guide] - Information on using the wiki software.

Revision as of 20:27, 9 June 2017

SPEDAS Graphical User Interface

Welcome to SPEDAS

Here you can find information and documentation for the Space Physics Environment Data Analysis Software (SPEDAS) framework. The most current version, SPEDAS 2.00, was released on June 9, 2017.

SPEDAS is a grass-roots data analysis software for the Space Physics community. It supports multi-mission data ingestion, analysis and visualization. It standardizes the retrieval of data from distributed repositories, the scientific processing with a powerful set of legacy routines, the quick visualization with full output control and the graph creation for use in papers and presentations.

The SPEDAS framework:

  • Contains a Graphical User Interface for ease of use by novice users.
  • Works with Windows, Linux and Mac OS X.
  • Is based on IDL, benefiting from platform independence and software maintenance services.
  • Can be used with or without an IDL license.

SPEDAS supports plugin modules for multiple projects (THEMIS, GOES, MMS, WIND, ERG, etc) and provides interfaces for software modules developed by the individual teams of those missions.

SPEDAS is concerned mostly with establishing developers' guidelines, communicating best practices, and providing peer review of new products to like-minded colleagues, towards an efficient space environment data analysis suite of software code.

Known Issues with XQuartz

If you're having trouble running the SPEDAS GUI, EVA, or any other code that involves IDL widgets on macOS or OSX, see the known issues page for a potential fix.

Introduction

* SPEDAS Youtube Channel - SPEDAS introductory videos
* Starting with SPEDAS - Video: how to download and install SPEDAS 
* MMS data analysis using SPEDAS: an introduction  - Video: how to use MMS data with SPEDAS 
* MMS multi-instrument plots  - Video: how to create MMS multi-panel, multi-instrument plots with SPEDAS 
* SPEDAS Screenshots - SPEDAS screenshots
* Introductory Examples - Examples for first-time users
* SPEDAS Presentations - PowerPoint presentations on SPEDAS

Downloads and Installation

* New! SPEDAS 2.00 released (June 2017) 
* Nightly build - Quick link to the nightly "bleeding edge" SPEDAS source code zip file.  
* Downloads and Installation - Detailed instructions for downloading and installing SPEDAS.

The nightly builds are zip files containing a snapshot of the SPEDAS source code repository. They have not been through our full QA process, but they do have the very latest features and bug fixes, and this is what many researchers are using.

The current, fully-QAed version is available from the Downloads and Installation page, in several different formats. In addition to the IDL source code files, this page includes download links to pre-compiled, executable versions of SPEDAS, which do not require a separate, paid, IDL license.

Supported Missions

SPEDAS contains specialized plugins that can download, analyze and plot data from multiple space missions, including:

* BARREL
* ERG
* FAST
* GOES
* IUGONET
* MMS
* POES
* THEMIS/ARTEMIS
* WIND

Documentation

* HTML documentation - Documentation of SPEDAS functions, with source code and search
* User's Guide - Documentation for users
* Plugin Guide - Documentation for plugin developers
* Crib Sheets - Step-by-step usage scenarios 
* Tips and Tricks - SPEDAS tips and tricks 
* Data Model - Description of the data model used in SPEDAS
* Time Handling - Description of how times are used in SPEDAS
* 3D Data structures - Description of the data structures used in many SPEDAS particle data sets.
* 3D Data Conversion Factors - Description of the conversion factors used for different data quantities, for particle data.

External Resources

* SPEDAS Blog - SPEDAS Developer Blog and Announcements 
* SPEDAS ChangeLog - Recent changes to the bleeding edge
* Overview Plots - Summary plots generated with SPEDAS
* IDL Documentation - IDL Documentation by Exelis
* Wiki User's Guide - Information on using the wiki software.