# Digisonde Indices
Digisonde Indices is a downloader and parser that retrieves Digisonde data from [DIDBase](https://giro.uml.edu/didbase/). Output datatype is [xarray.DataSet](https://docs.xarray.dev/en/latest/generated/xarray.Dataset.html). Missing data is returned as an empty dataset.
### Data Selection:
1. CS is Autoscaling Confidence Score (from 0 to 100, 999 if manual scaling, -1 if unknown)
2. foF2 (MHz) - F2 layer critical frequency
3. foF1 (MHz) - F1 layer critical frequency
4. MUFD (MHz) - Maximum usable frequency for ground distance D
5. foE (MHz) - E layer critical frequency
6. hF (km) - Minimum virtual height of F trace
7. hF2 (km) - Minimum virtual height of F2 trace
8. hmE (km) - Peak height of E-layer
9. hmF2 (km) - Peak height F2-layer
10. hmF1 (km) - Peak height F1-layer
11. yF2 (km) - Half thickness of F2-layer, parabolic model
12. yF1 (km) - Half thickness of F1-layer, parabolic model
13. B0 (km) - IRI thickness parameter
14. TEC (m^-2) - Total electron content
### Example
Use from other scripts like:
```py
import digisondeindices as didbase
import datetime as dt
# timezone-unaware example
date = dt.datetime(2012, 1, 1, 5, 0, 0) # 2012-01-01 05:00:00 UTC, even though datetime object created in timezone of machine at runtime
inds = didbase.get_indices(date, 'AH223') # retrieve data from Ahmedabad station
# timezone-aware example
date = dt.datetime(2012, 1, 1, 5, 0, 0) # 2012-01-01 10:00:00 UTC for US/Eastern (UTC-05:00) given execution machine time zone is set to US/Eastern
inds = didbase.get_indices(date, 'AH223', tzaware=True) # retrieve data from Ahmedabad station
```
Returned indices are always in UTC (as `numpy.datetime64`).
A list of available stations is provided by the [Global Ionosphere Radio Observatory](https://giro.uml.edu/index.html):
[DIDBase stations list](https://lgdc.uml.edu/common/DIDBFastStationList)
## Data License
All GIRO measurements are released under CC-BY-NC-SA 4.0 license.
Please follow the [Lowell GIRO Data Center RULES OF THE ROAD](https://ulcar.uml.edu/DIDBase/RulesOfTheRoadForDIDBase.htm).
Requires acknowledgement of station data provider.
Raw data
{
"_id": null,
"home_page": "https://github.com/sunipkm/digisondeindices",
"name": "digisondeindices",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "aeronomy, aurora, ionosphere",
"author": "Sunip K. Mukherjee",
"author_email": "sunipkmukherjee@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/42/7b/4a778ac3e868baabf5266f0ce6a7bfda347b56f0d9627a7dd8025bca4afc/digisondeindices-2.1.0.tar.gz",
"platform": null,
"description": "# Digisonde Indices\nDigisonde Indices is a downloader and parser that retrieves Digisonde data from [DIDBase](https://giro.uml.edu/didbase/). Output datatype is [xarray.DataSet](https://docs.xarray.dev/en/latest/generated/xarray.Dataset.html). Missing data is returned as an empty dataset. \n\n### Data Selection:\n1. CS is Autoscaling Confidence Score (from 0 to 100, 999 if manual scaling, -1 if unknown)\n2. foF2 (MHz) - F2 layer critical frequency\n3. foF1 (MHz) - F1 layer critical frequency\n4. MUFD (MHz) - Maximum usable frequency for ground distance D\n5. foE (MHz) - E layer critical frequency\n6. hF (km) - Minimum virtual height of F trace\n7. hF2 (km) - Minimum virtual height of F2 trace\n8. hmE (km) - Peak height of E-layer\n9. hmF2 (km) - Peak height F2-layer\n10. hmF1 (km) - Peak height F1-layer\n11. yF2 (km) - Half thickness of F2-layer, parabolic model\n12. yF1 (km) - Half thickness of F1-layer, parabolic model\n13. B0 (km) - IRI thickness parameter\n14. TEC (m^-2) - Total electron content\n\n### Example\nUse from other scripts like:\n\n```py\nimport digisondeindices as didbase\nimport datetime as dt\n\n# timezone-unaware example\ndate = dt.datetime(2012, 1, 1, 5, 0, 0) # 2012-01-01 05:00:00 UTC, even though datetime object created in timezone of machine at runtime\ninds = didbase.get_indices(date, 'AH223') # retrieve data from Ahmedabad station\n\n# timezone-aware example\ndate = dt.datetime(2012, 1, 1, 5, 0, 0) # 2012-01-01 10:00:00 UTC for US/Eastern (UTC-05:00) given execution machine time zone is set to US/Eastern\ninds = didbase.get_indices(date, 'AH223', tzaware=True) # retrieve data from Ahmedabad station\n```\nReturned indices are always in UTC (as `numpy.datetime64`).\n\nA list of available stations is provided by the [Global Ionosphere Radio Observatory](https://giro.uml.edu/index.html):\n[DIDBase stations list](https://lgdc.uml.edu/common/DIDBFastStationList)\n\n## Data License\nAll GIRO measurements are released under CC-BY-NC-SA 4.0 license.\nPlease follow the [Lowell GIRO Data Center RULES OF THE ROAD](https://ulcar.uml.edu/DIDBase/RulesOfTheRoadForDIDBase.htm).\nRequires acknowledgement of station data provider.\n",
"bugtrack_url": null,
"license": null,
"summary": "Download and parse Digisonde data products.",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/sunipkm/digisondeindices"
},
"split_keywords": [
"aeronomy",
" aurora",
" ionosphere"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ef1e24efe623ca2ba9660489da57e55e8f158934e855b537e2c0096b1ed4bef",
"md5": "e7d88b68a8d74f252a70f4ed98b7d82f",
"sha256": "90f8f8467650cf5ea8b26d5f83570158ebad735e138eb3be9fd3dd5474caf70a"
},
"downloads": -1,
"filename": "digisondeindices-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7d88b68a8d74f252a70f4ed98b7d82f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8724,
"upload_time": "2024-11-15T20:44:06",
"upload_time_iso_8601": "2024-11-15T20:44:06.644037Z",
"url": "https://files.pythonhosted.org/packages/5e/f1/e24efe623ca2ba9660489da57e55e8f158934e855b537e2c0096b1ed4bef/digisondeindices-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "427b4a778ac3e868baabf5266f0ce6a7bfda347b56f0d9627a7dd8025bca4afc",
"md5": "b671988e0cc00dec79ab67ddaceff753",
"sha256": "6915172b97f9cdc0daf30ba7a61f97d73de81eef7694f9fe5c7877e41c0fd61e"
},
"downloads": -1,
"filename": "digisondeindices-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b671988e0cc00dec79ab67ddaceff753",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8744,
"upload_time": "2024-11-15T20:44:07",
"upload_time_iso_8601": "2024-11-15T20:44:07.749622Z",
"url": "https://files.pythonhosted.org/packages/42/7b/4a778ac3e868baabf5266f0ce6a7bfda347b56f0d9627a7dd8025bca4afc/digisondeindices-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 20:44:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sunipkm",
"github_project": "digisondeindices",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"lcname": "digisondeindices"
}
JSON
