## SDO Image Parameter Python API
### A Toolkit for Accessing Solar Image Data
This project was created to facilitate accessing the Image Parameter Web API
available at http://dmlab.cs.gsu.edu/dmlabapi/ using a Python package.
**Developer**: Ruqayyah Muse (ruqayyahmuse@gmail.com)
**Advisor**: Dr. Azim Ahmadzadeh (aahmadzadeh1@gsu.edu)
___
## Requirements
* Python >= 3.8
* For a list of all required packages, see requirements.txt.
___
## Try it Online
[](https://mybinder.org/v2/git/https%3A%2F%2Fbitbucket.org%2Fds4350-image-param-api-rm%2Fsolar-image-api.git/ee19be7489ff17328b257ffcf3fd400dbb926e85?labpath=src%2Fdemo.ipynb)
---
## Install it from PyPI
You can install this package using pip:
`pip install sdo-image-parameter-api`
---
## File Structure:
- `sdo_image_parameter_api/image_methods.py` contains all the methods used
for retrieving image information. Includes the four accessor methods
described in the next section, as well as the 8 private methods that make
the calls to the Web API.
- `sdo_image_parameter_api/constants.py` includes all the defined constants
for Format, InfoType, Wave, Size, Param, as well as the URLs to retrieve
information with the Web API.
- `sdo_image_parameter_api/util/converters.py` includes methods to
convert XML ElementTree objects into NumPy arrays.
- `sdo_image_parameter_api/util/validators.py` includes methods to
format and validate given time parameters, as well as validate
all other inputted arguments.
---
## Method Options
There are four methods that return different types of image information.
* The **get_img_jpeg()** method can be used to return an AIA JPEG image, or a
JPEG Parameter image.
* The **get_img_param()** method can be used to
return image parameters of one image of the sun in XML or JSON format.
* The **get_img_param_range()** method can be used to return image
parameters of a range of images of the sun in XML or JSON format.
* The **get_img_header()** method can be used to return image header
information in XML or JSON format.
The required parameters for each method and how to run them for each type of
output is explained in more detail in the Notebook (src/demo.ipynb)
***
## Acknowledgements
Thank you to Dr. Azim Ahmadzadeh for his guidance during the building of
this project.
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/ds4350-image-param-api-rm/solar-image-api/src/main/",
"name": "sdo-image-parameter-api",
"maintainer": "Ruqayyah Muse",
"docs_url": null,
"requires_python": "",
"maintainer_email": "ruqayyahmuse@gmail.com",
"keywords": "sun,sdo,solar images,parameters",
"author": "Ruqayyah Muse",
"author_email": "ruqayyahmuse@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4f/77/10de049a9bb6cf3fc45fac802189c4096aa355aa2bbe091d7490ab54d1ae/sdo_image_parameter_api-0.1.0.tar.gz",
"platform": null,
"description": "\r\n\r\n## SDO Image Parameter Python API\r\n### A Toolkit for Accessing Solar Image Data\r\n\r\nThis project was created to facilitate accessing the Image Parameter Web API \r\navailable at http://dmlab.cs.gsu.edu/dmlabapi/ using a Python package.\r\n\r\n**Developer**: Ruqayyah Muse (ruqayyahmuse@gmail.com)\r\n\r\n**Advisor**: Dr. Azim Ahmadzadeh (aahmadzadeh1@gsu.edu)\r\n\r\n___\r\n\r\n\r\n## Requirements\r\n * Python >= 3.8\r\n * For a list of all required packages, see requirements.txt.\r\n\r\n___\r\n\r\n\r\n## Try it Online\r\n\r\n[](https://mybinder.org/v2/git/https%3A%2F%2Fbitbucket.org%2Fds4350-image-param-api-rm%2Fsolar-image-api.git/ee19be7489ff17328b257ffcf3fd400dbb926e85?labpath=src%2Fdemo.ipynb)\r\n\r\n---\r\n\r\n## Install it from PyPI\r\nYou can install this package using pip: \r\n`pip install sdo-image-parameter-api`\r\n\r\n---\r\n\r\n## File Structure:\r\n\r\n- `sdo_image_parameter_api/image_methods.py` contains all the methods used \r\n for retrieving image information. Includes the four accessor methods \r\n described in the next section, as well as the 8 private methods that make \r\n the calls to the Web API.\r\n- `sdo_image_parameter_api/constants.py` includes all the defined constants \r\n for Format, InfoType, Wave, Size, Param, as well as the URLs to retrieve \r\n information with the Web API.\r\n- `sdo_image_parameter_api/util/converters.py` includes methods to \r\n convert XML ElementTree objects into NumPy arrays.\r\n- `sdo_image_parameter_api/util/validators.py` includes methods to \r\n format and validate given time parameters, as well as validate \r\n all other inputted arguments.\r\n\r\n---\r\n\r\n## Method Options\r\n\r\nThere are four methods that return different types of image information. \r\n\r\n * The **get_img_jpeg()** method can be used to return an AIA JPEG image, or a\r\n JPEG Parameter image. \r\n * The **get_img_param()** method can be used to \r\n return image parameters of one image of the sun in XML or JSON format.\r\n * The **get_img_param_range()** method can be used to return image \r\n parameters of a range of images of the sun in XML or JSON format. \r\n * The **get_img_header()** method can be used to return image header \r\n information in XML or JSON format.\r\n\r\nThe required parameters for each method and how to run them for each type of\r\noutput is explained in more detail in the Notebook (src/demo.ipynb)\r\n\r\n***\r\n\r\n## Acknowledgements\r\n\r\nThank you to Dr. Azim Ahmadzadeh for his guidance during the building of \r\nthis project.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A toolkit for accessing solar image data",
"version": "0.1.0",
"split_keywords": [
"sun",
"sdo",
"solar images",
"parameters"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d94f155e0504823128e9067493cdb39fe6ff817e8372986c59eecffd04b7942e",
"md5": "cfaf564314498f817e761d49396c2237",
"sha256": "d2b87208af8b9edf24d2ebfe9cf2a219e63c81b1d58f415a8567023ef13558e4"
},
"downloads": -1,
"filename": "sdo_image_parameter_api-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cfaf564314498f817e761d49396c2237",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9616,
"upload_time": "2023-04-27T01:00:36",
"upload_time_iso_8601": "2023-04-27T01:00:36.043532Z",
"url": "https://files.pythonhosted.org/packages/d9/4f/155e0504823128e9067493cdb39fe6ff817e8372986c59eecffd04b7942e/sdo_image_parameter_api-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f7710de049a9bb6cf3fc45fac802189c4096aa355aa2bbe091d7490ab54d1ae",
"md5": "8e1c6e23007543ada7b256448c29a024",
"sha256": "c339ef2b71bc2a9199ccbf9ea1738c890d2724b5e429c693cc4d3a15e6b75661"
},
"downloads": -1,
"filename": "sdo_image_parameter_api-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8e1c6e23007543ada7b256448c29a024",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9541,
"upload_time": "2023-04-27T01:00:37",
"upload_time_iso_8601": "2023-04-27T01:00:37.812201Z",
"url": "https://files.pythonhosted.org/packages/4f/77/10de049a9bb6cf3fc45fac802189c4096aa355aa2bbe091d7490ab54d1ae/sdo_image_parameter_api-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-27 01:00:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "sdo-image-parameter-api"
}
JSON