# 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": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "examples spedas data tools",
"author": "Jim Lewis",
"author_email": "jwl@ssl.berkeley.edu",
"download_url": "https://files.pythonhosted.org/packages/29/05/112fab351acdb88f8dd890ae7246ecd09f5c9672e5aba91f94e03dfbe40d/pyspedas_examples-0.4.0.tar.gz",
"platform": null,
"description": "\n# PySPEDAS Examples\n\nThis project contains general examples and turorials for pySPEDAS.\n\n\n## Requirements\n\nPython 3.8+ is required.\n\n\n## Installation\n\nTo install the examples, use the following command:\n```bash\npip install pyspedas_examples\n```\n\nTo upgrade the examples from a previous version, use the following command:\n```bash\npip install pyspedas_examples --upgrade\n```\n\nInstalling pyspedas_examples will also install pyspedas and all other required packages.\n\n\n### Running the examples\n\nTo run one of the examples using the python command line, use the following commands:\n\n```bash\nfrom pyspedas_examples import ex_basic\nex_basic()\n```\n\nAlternatively, you can open the example file using an editor (like Visual Studio Code) and run it directly.\n\n\n## Additional examples\n\nAdditional, mission-specific examples, can be found in the repositories:\n\nMagnetospheric Multiscale Mission (MMS):\nhttps://github.com/spedas/mms-examples\n\nTime History of Events and Macroscale Interactions during Substorms (THEMIS):\nhttps://github.com/spedas/themis-examples\n\n\n## Additional Information\n\nFor documentation on PySPEDAS, see: https://pyspedas.readthedocs.io/\n\nFor documentation on PyTplot, see: https://pytplot.readthedocs.io/\n\nFor documentation on cdflib, see: https://cdflib.readthedocs.io/\n\nFor more information on IDL SPEDAS, see http://spedas.org/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Examples of pySPEDAS",
"version": "0.4.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": "044eaf2ddde51457ba4606d17295aec941293e3bc01b787f650ab65d003a9d32",
"md5": "c250b9affb41896d6f0d1c09e2c99a88",
"sha256": "ae354621f58b2ac119c844aca53f62ba422be0af6344fe7b1b4c5f95b90f66a4"
},
"downloads": -1,
"filename": "pyspedas_examples-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c250b9affb41896d6f0d1c09e2c99a88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 17608,
"upload_time": "2024-07-08T15:43:14",
"upload_time_iso_8601": "2024-07-08T15:43:14.280952Z",
"url": "https://files.pythonhosted.org/packages/04/4e/af2ddde51457ba4606d17295aec941293e3bc01b787f650ab65d003a9d32/pyspedas_examples-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2905112fab351acdb88f8dd890ae7246ecd09f5c9672e5aba91f94e03dfbe40d",
"md5": "a1d9596b34771cc63d7d5726a6fcb0ff",
"sha256": "eed7f9f6a62a15fc7d3778c244098e0ee5c9d094a752b2aa08d03dfafa1a269c"
},
"downloads": -1,
"filename": "pyspedas_examples-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "a1d9596b34771cc63d7d5726a6fcb0ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12352,
"upload_time": "2024-07-08T15:43:16",
"upload_time_iso_8601": "2024-07-08T15:43:16.108750Z",
"url": "https://files.pythonhosted.org/packages/29/05/112fab351acdb88f8dd890ae7246ecd09f5c9672e5aba91f94e03dfbe40d/pyspedas_examples-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 15:43:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spedas",
"github_project": "pyspedas_examples",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pyspedas",
"specs": [
[
">=",
"1.5.16"
]
]
}
],
"lcname": "pyspedas-examples"
}
JSON
