Main Page: Difference between revisions
Jump to navigation
Jump to search
m (→Documentation) |
|||
| (92 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
[[File: | [[File:spedas_overview_d.png|200px|thumb|right|SPEDAS Graphical User Interface]] | ||
= Looking for PySPEDAS? = | |||
The PySPEDAS section of the wiki is here: [[PySPEDAS]] | |||
= Welcome to SPEDAS = | = Welcome to SPEDAS = | ||
Here you can find information and documentation for the Space Physics Environment Data Analysis Software (SPEDAS) framework. | Here you can find information and documentation for the Space Physics Environment Data Analysis Software (SPEDAS) framework. The most current version, SPEDAS 6.0, was released in December 2023. | ||
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 17: | ||
* 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 == | |||
=== macOS === | |||
If you're having trouble running the SPEDAS GUI, EVA, or any other code that involves IDL widgets on macOS or OSX, see the [https://spedas.org/wiki/index.php?title=Known_Issues_macOS macOS known issues page for a potential fix]. | |||
=== Windows === | |||
[https://spedas.org/wiki/index.php?title=Known_Issues_Windows Unable to allocate memory: to make array - Heap Problems]. | |||
=== MMS downloads failing? (updated June 26, 2020) === | |||
A change was made to the LASP SDC servers that broke access to the MMS datasets using SPEDAS in June 2020; if you're running an older version of SPEDAS, we suggest updating to the latest bleeding edge zip: | |||
[https://themis.ssl.berkeley.edu/socware/bleeding_edge/spdsw_latest.zip Download Bleeding Edge]. | |||
</div> | |||
== Introduction == | == Introduction == | ||
* [ | * [https://www.youtube.com/channel/UCZVyhCNPI3II7Mu086KsoLA SPEDAS Youtube Channel] - SPEDAS introductory videos | ||
* [ | * [https://www.youtube.com/watch?v=nXy03dvfcEY Starting with SPEDAS] - Video: how to download and install SPEDAS | ||
* [[ | * [https://www.youtube.com/watch?v=390FguKn7w4 MMS data analysis using SPEDAS: an introduction ] - Video: how to use MMS data with SPEDAS | ||
* [[ | * [https://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 | |||
* [[Usage examples|Introductory Examples]] - Examples for first-time users | |||
* [[SPEDAS Presentations]] - PowerPoint presentations on SPEDAS | |||
== Downloads == | == Downloads and Installation == | ||
* [ | * [[Downloads and Installation|<span style="color:red">New! SPEDAS 6.1 released (May 2024)</span>]] | ||
* [[ | * [https://spedas.org/downloads/spdsw_latest.zip Nightly build] - Quick link to the nightly "bleeding edge" SPEDAS source code zip file. | ||
* [ | * [[Downloads and Installation]] - Detailed instructions for downloading and installing SPEDAS. | ||
* [[IDL versions|Supported IDL Versions]] - List of supported IDL versions | |||
* [[SPEDAS Archive]] - Previous SPEDAS versions | |||
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 == | == Supported Missions == | ||
SPEDAS contains specialized plugins that can download, analyze and plot data from multiple space missions, including: | |||
* [[ | |||
* [[BARREL]] | |||
* [[ERG]] | * [[ERG]] | ||
* [[FAST]] | |||
* [[GOES]] | * [[GOES]] | ||
* [[IUGONET]] | |||
* [[MMS]] | |||
* [[POES]] | |||
* [[THEMIS|THEMIS/ARTEMIS]] | |||
* [[WIND]] | * [[WIND]] | ||
* [[ | * [[DSCOVR]] | ||
* [[ICON]] | |||
== Publications == | |||
The following links contain lists of refereed publications that have used SPEDAS as a data analysis tool | |||
* [https://www.spedas.org/papers/SPEDAS_18.html 2018 Publications] | |||
== Citing SPEDAS == | |||
[https://doi.org/10.1007/s11214-018-0576-4 The Space Physics Environment Data Analysis System (SPEDAS)] has recently (December 2018) been accepted for publication in [https://link.springer.com/journal/11214 Space Science Reviews] : | |||
https://doi.org/10.1007/s11214-018-0576-4 | |||
If you benefit from SPEDAS code, please consider citing this | |||
paper. You can simply add the citation in your acknowledgment, and that | |||
could include your software version. For example: "Data access and | |||
processing was done using SPEDAS V3.1, see Angelopoulos et al., 2019" and | |||
that would be natural and informative for readers. | |||
== Documentation == | == Documentation == | ||
* [ | * [https://themis.ssl.berkeley.edu/socware/latest.html HTML Documentation] - Documentation of SPEDAS functions, with source code | ||
* [[ | * [[User's guide|User's Guide]] - Documentation for users | ||
* [[ | * [[SPEDAS Developer's Guide|Developer's Guide]] - Documentation for plugin developers | ||
* [[Crib sheets|Crib Sheets]] - Step-by-step usage scenarios | |||
* [[ | * [[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 | ||
* [[ | * [[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. | |||
* [[Autoplot Interface]] - Description of the Autoplot interface | |||
* [[Heliophysics Application Programmer’s Interface|Heliophysics Application Programmer’s Interface (HAPI)]] - Description of how to access HAPI data using SPEDAS | |||
== External Resources == | == External Resources == | ||
* [ | * [https://spedas.org/LICENSE.txt LICENSE.txt] - License for the SPEDAS framework | ||
* [ | * [https://spedas.org/blog/ SPEDAS Blog] - SPEDAS Developer Blog and Announcements | ||
* [ | * [https://spedas.org/changelog/ SPEDAS ChangeLog] - Recent changes to the bleeding edge | ||
* [https://themis.ssl.berkeley.edu/summary.shtml?autoload=1 Overview Plots] - Summary plots generated with SPEDAS | |||
* [https://www.nv5geospatialsoftware.com/docs/using_idl_home.html IDL Documentation] - IDL Documentation by NV5 Geospatial Software | |||
* [//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. | ||
* Information on [ftp://ftp.lpp.polytechnique.fr/robert/keep/HERITAGE/Rocotlib_V3p0/doc_ROCOTLIB_V3p0.pdf the coordinate transformation library Rocotlib] and on [ftp://ftp.lpp.polytechnique.fr/robert/keep/HERITAGE/Easy_method_to_compute_polarisation/Easy_method_to_compute_polarisation.pdf a method for computing wave polarization] | |||
== Python == | |||
* [[PySPEDAS]] - Portal to PySPEDAS information | |||
* [[Getting Started with pySPEDAS]] - SPEDAS software in the Python programming language | |||
* [https://github.com/spedas/pyspedas PySPEDAS bleeding edge] - PySPEDAS bleeding edge, hosted at GitHub | |||
* [https://pyspedas.readthedocs.io/ PySPEDAS documentation] - PySPEDAS documentation, hosted at ReadTheDocs | |||
Latest revision as of 00:49, 1 June 2024
Looking for PySPEDAS?
The PySPEDAS section of the wiki is here: PySPEDAS
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 6.0, was released in December 2023.
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
macOS
If you're having trouble running the SPEDAS GUI, EVA, or any other code that involves IDL widgets on macOS or OSX, see the macOS known issues page for a potential fix.
Windows
Unable to allocate memory: to make array - Heap Problems.
MMS downloads failing? (updated June 26, 2020)
A change was made to the LASP SDC servers that broke access to the MMS datasets using SPEDAS in June 2020; if you're running an older version of SPEDAS, we suggest updating to the latest bleeding edge zip:
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 6.1 released (May 2024) * Nightly build - Quick link to the nightly "bleeding edge" SPEDAS source code zip file. * Downloads and Installation - Detailed instructions for downloading and installing SPEDAS. * Supported IDL Versions - List of supported IDL versions * SPEDAS Archive - Previous SPEDAS versions
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 * DSCOVR * ICON
Publications
The following links contain lists of refereed publications that have used SPEDAS as a data analysis tool
Citing SPEDAS
The Space Physics Environment Data Analysis System (SPEDAS) has recently (December 2018) been accepted for publication in Space Science Reviews :
https://doi.org/10.1007/s11214-018-0576-4
If you benefit from SPEDAS code, please consider citing this
paper. You can simply add the citation in your acknowledgment, and that
could include your software version. For example: "Data access and
processing was done using SPEDAS V3.1, see Angelopoulos et al., 2019" and
that would be natural and informative for readers.
Documentation
* HTML Documentation - Documentation of SPEDAS functions, with source code * User's Guide - Documentation for users * Developer's 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. * Autoplot Interface - Description of the Autoplot interface * Heliophysics Application Programmer’s Interface (HAPI) - Description of how to access HAPI data using SPEDAS
External Resources
* LICENSE.txt - License for the SPEDAS framework * 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 NV5 Geospatial Software * Wiki User's Guide - Information on using the wiki software. * Information on the coordinate transformation library Rocotlib and on a method for computing wave polarization
Python
* PySPEDAS - Portal to PySPEDAS information * Getting Started with pySPEDAS - SPEDAS software in the Python programming language * PySPEDAS bleeding edge - PySPEDAS bleeding edge, hosted at GitHub * PySPEDAS documentation - PySPEDAS documentation, hosted at ReadTheDocs