seppy
=====
|pypi Version| |python version| |pytest| |codecov| |zenodo doi|
.. |pypi Version| image:: https://img.shields.io/pypi/v/seppy?style=flat&logo=pypi
:target: https://pypi.org/project/seppy/
.. |python version| image:: https://img.shields.io/pypi/pyversions/seppy?style=flat&logo=python
.. |zenodo doi| image:: https://zenodo.org/badge/451799504.svg
:target: https://zenodo.org/badge/latestdoi/451799504
.. |pytest| image:: https://github.com/serpentine-h2020/SEPpy/actions/workflows/pytest.yml/badge.svg?branch=main
.. |codecov| image:: https://codecov.io/gh/serpentine-h2020/SEPpy/branch/main/graph/badge.svg?token=FYELM4Y7DF
:target: https://codecov.io/gh/serpentine-h2020/SEPpy
*This package is in development status! Intended for internal use only, as the syntax is in a floating state and the documentation is incomplete.*
**A compendium of Python data loaders and analysis tools for in-situ measurements of Solar Energetic Particles (SEP)**
So far combines loaders for the following instruments into one PyPI package:
- Parker Solar Probe: ISOIS
- SOHO: CELIAS, COSTEP-EPHIN, ERNE
- Solar Orbiter: EPD (STEP, EPT, HET)*, MAG
- STEREO: HET, LET, SEPT, MAG
- Wind: 3DP
(* Note that `solo-epd-loader <https://github.com/jgieseler/solo-epd-loader>`_ is a `PyPI package itself <https://pypi.org/project/solo-epd-loader/>`_ that just is loaded here for completeness.)
Disclaimer
----------
This software is provided "as is", with no guarantee. It is no official data source, and not officially endorsed by the corresponding instrument teams. **Please always refer to the official data description of each instrument before using the data!**
Installation
------------
seppy requires python >= 3.8.
It can be installed from `PyPI <https://pypi.org/project/seppy/>`_ using:
.. code:: bash
pip install seppy
Usage
-----
The standard usecase is to utilize the ``***_load`` function, which returns Pandas dataframe(s) of the corresponding measurements and a dictionary containing information on the energy channels. For example the SOHO/ERNE data from Apr 16 to Apr 20, 2021, can be obtained as follows:
.. code:: python
from seppy.loader.soho import soho_load
df, meta = soho_load(dataset="SOHO_ERNE-HED_L2-1MIN",
startdate="2021/04/16",
enddate="2021/04/20")
Note that the syntax is different for each loader! `Please refer to this Notebook for more info and examples for the different data sets! <https://github.com/jgieseler/serpentine/blob/main/notebooks/sep_analysis_tools/data_loader.ipynb>`_
Citation
--------
Please cite the following paper if you use **seppy** in your publication:
Palmroos, C., Gieseler, J., Dresing, N., Morosan, D.E., Asvestari, E., Yli-Laurila, A., Price, D.J., Valkila, S., Vainio, R. (2022).
Solar Energetic Particle Time Series Analysis with Python. *Front. Astronomy Space Sci.* 9. `doi:10.3389/fspas.2022.1073578 <https://doi.org/10.3389/fspas.2022.1073578>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/serpentine-h2020/SEPpy",
"name": "seppy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Jan Gieseler",
"author_email": "jan.gieseler@utu.fi",
"download_url": "https://files.pythonhosted.org/packages/a5/7e/4e79d73a02a770f52be9e3beca55dcd8ce92940d39e8e75e3336387b9552/seppy-0.1.17.tar.gz",
"platform": null,
"description": "seppy\n=====\n\n|pypi Version| |python version| |pytest| |codecov| |zenodo doi|\n\n.. |pypi Version| image:: https://img.shields.io/pypi/v/seppy?style=flat&logo=pypi\n :target: https://pypi.org/project/seppy/\n.. |python version| image:: https://img.shields.io/pypi/pyversions/seppy?style=flat&logo=python\n.. |zenodo doi| image:: https://zenodo.org/badge/451799504.svg\n :target: https://zenodo.org/badge/latestdoi/451799504\n.. |pytest| image:: https://github.com/serpentine-h2020/SEPpy/actions/workflows/pytest.yml/badge.svg?branch=main\n.. |codecov| image:: https://codecov.io/gh/serpentine-h2020/SEPpy/branch/main/graph/badge.svg?token=FYELM4Y7DF \n :target: https://codecov.io/gh/serpentine-h2020/SEPpy\n\n*This package is in development status! Intended for internal use only, as the syntax is in a floating state and the documentation is incomplete.*\n\n**A compendium of Python data loaders and analysis tools for in-situ measurements of Solar Energetic Particles (SEP)**\n\nSo far combines loaders for the following instruments into one PyPI package:\n\n- Parker Solar Probe: ISOIS\n- SOHO: CELIAS, COSTEP-EPHIN, ERNE\n- Solar Orbiter: EPD (STEP, EPT, HET)*, MAG\n- STEREO: HET, LET, SEPT, MAG\n- Wind: 3DP\n\n(* Note that `solo-epd-loader <https://github.com/jgieseler/solo-epd-loader>`_ is a `PyPI package itself <https://pypi.org/project/solo-epd-loader/>`_ that just is loaded here for completeness.)\n\n\nDisclaimer\n----------\nThis software is provided \"as is\", with no guarantee. It is no official data source, and not officially endorsed by the corresponding instrument teams. **Please always refer to the official data description of each instrument before using the data!**\n\nInstallation\n------------\n\nseppy requires python >= 3.8.\n\nIt can be installed from `PyPI <https://pypi.org/project/seppy/>`_ using:\n\n.. code:: bash\n\n pip install seppy\n\n\nUsage\n-----\n\nThe standard usecase is to utilize the ``***_load`` function, which returns Pandas dataframe(s) of the corresponding measurements and a dictionary containing information on the energy channels. For example the SOHO/ERNE data from Apr 16 to Apr 20, 2021, can be obtained as follows:\n\n.. code:: python\n\n from seppy.loader.soho import soho_load\n\n df, meta = soho_load(dataset=\"SOHO_ERNE-HED_L2-1MIN\",\n startdate=\"2021/04/16\",\n enddate=\"2021/04/20\")\n\nNote that the syntax is different for each loader! `Please refer to this Notebook for more info and examples for the different data sets! <https://github.com/jgieseler/serpentine/blob/main/notebooks/sep_analysis_tools/data_loader.ipynb>`_\n\n\n\n\nCitation\n--------\n\nPlease cite the following paper if you use **seppy** in your publication:\n\nPalmroos, C., Gieseler, J., Dresing, N., Morosan, D.E., Asvestari, E., Yli-Laurila, A., Price, D.J., Valkila, S., Vainio, R. (2022).\nSolar Energetic Particle Time Series Analysis with Python. *Front. Astronomy Space Sci.* 9. `doi:10.3389/fspas.2022.1073578 <https://doi.org/10.3389/fspas.2022.1073578>`_ \n",
"bugtrack_url": null,
"license": "BSD 3-clause",
"summary": "SEPpy",
"version": "0.1.17",
"project_urls": {
"Homepage": "https://github.com/serpentine-h2020/SEPpy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ba87079d80b03301063cdece1562e59898ea95d7ffe4ba73df936581615c24c",
"md5": "a44e1468f9ff4167fb22edf83a2c2237",
"sha256": "e46eacacf130925d87366865d0c5d818ccabae913586d12a917cd88fa6eace30"
},
"downloads": -1,
"filename": "seppy-0.1.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a44e1468f9ff4167fb22edf83a2c2237",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 338006,
"upload_time": "2025-01-15T13:43:26",
"upload_time_iso_8601": "2025-01-15T13:43:26.463419Z",
"url": "https://files.pythonhosted.org/packages/0b/a8/7079d80b03301063cdece1562e59898ea95d7ffe4ba73df936581615c24c/seppy-0.1.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a57e4e79d73a02a770f52be9e3beca55dcd8ce92940d39e8e75e3336387b9552",
"md5": "c55956356ed2bf8bda0e78b390c15ca6",
"sha256": "92b97ae4d4c0152078a6e9ede643fe7474a8c62a45e738309f4f55290e53836a"
},
"downloads": -1,
"filename": "seppy-0.1.17.tar.gz",
"has_sig": false,
"md5_digest": "c55956356ed2bf8bda0e78b390c15ca6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 331979,
"upload_time": "2025-01-15T13:43:29",
"upload_time_iso_8601": "2025-01-15T13:43:29.356799Z",
"url": "https://files.pythonhosted.org/packages/a5/7e/4e79d73a02a770f52be9e3beca55dcd8ce92940d39e8e75e3336387b9552/seppy-0.1.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-15 13:43:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "serpentine-h2020",
"github_project": "SEPpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "astropy",
"specs": []
},
{
"name": "astroquery",
"specs": []
},
{
"name": "bs4",
"specs": []
},
{
"name": "cdflib",
"specs": [
[
">=",
"0.4.9"
]
]
},
{
"name": "ipywidgets",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "mpl-animators",
"specs": [
[
">=",
"1.0.0"
]
]
},
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "pooch",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "setuptools",
"specs": []
},
{
"name": "solo-epd-loader",
"specs": []
},
{
"name": "sunpy",
"specs": [
[
">=",
"4.1.0"
]
]
}
],
"tox": true,
"lcname": "seppy"
}
JSON
