# PySPEDAS Examples
This project contains general examples and turorials for pySPEDAS.
## Requirements
Python 3.8+ is required.
## Installation
To install the examples, use the following command:
```bash
pip install pyspedas_examples
```
To upgrade the examples from a previous version, use the following command:
```bash
pip install pyspedas_examples --upgrade
```
Installing pyspedas_examples will also install pyspedas and all other required packages.
### Running the examples
To run one of the examples using the python command line, use the following commands:
```bash
from pyspedas_examples import ex_basic
ex_basic()
```
Alternatively, you can open the example file using an editor (like Visual Studio Code) and run it directly.
## Additional examples
Additional, mission-specific examples, can be found in the repositories:
Magnetospheric Multiscale Mission (MMS):
https://github.com/spedas/mms-examples
Time History of Events and Macroscale Interactions during Substorms (THEMIS):
https://github.com/spedas/themis-examples
## Additional Information
For documentation on PySPEDAS, see: https://pyspedas.readthedocs.io/
For documentation on PyTplot, see: https://pytplot.readthedocs.io/
For documentation on cdflib, see: https://cdflib.readthedocs.io/
For more information on IDL SPEDAS, see http://spedas.org/
Raw data
{
"_id": null,
"home_page": "https://github.com/spedas/pyspedas_examples",
"name": "pyspedas-examples",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "examples spedas data tools",
"author": "Jim Lewis",
"author_email": "jwl@ssl.berkeley.edu",
"download_url": "https://files.pythonhosted.org/packages/bf/f7/229e7dfc1607a145700707e9aff5fdc723c8ed0192b9847991cc985d3360/pyspedas_examples-0.3.0.tar.gz",
"platform": null,
"description": "\r\n# PySPEDAS Examples\r\n\r\nThis project contains general examples and turorials for pySPEDAS.\r\n\r\n\r\n## Requirements\r\n\r\nPython 3.8+ is required.\r\n\r\n\r\n## Installation\r\n\r\nTo install the examples, use the following command:\r\n```bash\r\npip install pyspedas_examples\r\n```\r\n\r\nTo upgrade the examples from a previous version, use the following command:\r\n```bash\r\npip install pyspedas_examples --upgrade\r\n```\r\n\r\nInstalling pyspedas_examples will also install pyspedas and all other required packages.\r\n\r\n\r\n### Running the examples\r\n\r\nTo run one of the examples using the python command line, use the following commands:\r\n\r\n```bash\r\nfrom pyspedas_examples import ex_basic\r\nex_basic()\r\n```\r\n\r\nAlternatively, you can open the example file using an editor (like Visual Studio Code) and run it directly.\r\n\r\n\r\n## Additional examples\r\n\r\nAdditional, mission-specific examples, can be found in the repositories:\r\n\r\nMagnetospheric Multiscale Mission (MMS):\r\nhttps://github.com/spedas/mms-examples\r\n\r\nTime History of Events and Macroscale Interactions during Substorms (THEMIS):\r\nhttps://github.com/spedas/themis-examples\r\n\r\n\r\n## Additional Information\r\n\r\nFor documentation on PySPEDAS, see: https://pyspedas.readthedocs.io/\r\n\r\nFor documentation on PyTplot, see: https://pytplot.readthedocs.io/\r\n\r\nFor documentation on cdflib, see: https://cdflib.readthedocs.io/\r\n\r\nFor more information on IDL SPEDAS, see http://spedas.org/\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Examples of pySPEDAS",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/spedas/pyspedas_examples",
"Information": "http://spedas.org/wiki/"
},
"split_keywords": [
"examples",
"spedas",
"data",
"tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ba67af8d411607a2f35fea97afbc3b879fc0f4f70995188b6fd06e85d8ffcc9",
"md5": "d5040a076d13f7492d09ef3806212584",
"sha256": "a9c853a30d34bb864b98c5f50a7176fd21f21fbdd561fc8f95bf0c4ef231656f"
},
"downloads": -1,
"filename": "pyspedas_examples-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5040a076d13f7492d09ef3806212584",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 17796,
"upload_time": "2023-12-09T23:34:56",
"upload_time_iso_8601": "2023-12-09T23:34:56.438603Z",
"url": "https://files.pythonhosted.org/packages/1b/a6/7af8d411607a2f35fea97afbc3b879fc0f4f70995188b6fd06e85d8ffcc9/pyspedas_examples-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bff7229e7dfc1607a145700707e9aff5fdc723c8ed0192b9847991cc985d3360",
"md5": "a98cb6816141dd70232b81834a668f33",
"sha256": "d4d387be1369f8d2674a7f46ff2be0182fac7b1d0e249ebee77b2a2d353fda12"
},
"downloads": -1,
"filename": "pyspedas_examples-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "a98cb6816141dd70232b81834a668f33",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12300,
"upload_time": "2023-12-09T23:34:58",
"upload_time_iso_8601": "2023-12-09T23:34:58.028202Z",
"url": "https://files.pythonhosted.org/packages/bf/f7/229e7dfc1607a145700707e9aff5fdc723c8ed0192b9847991cc985d3360/pyspedas_examples-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 23:34:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spedas",
"github_project": "pyspedas_examples",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyspedas-examples"
}
JSON
