geomagdata


Namegeomagdata JSON
Version 1.6.1 PyPI version JSON
download
home_pagehttps://github.com/sunipkm/geomagdata
SummaryDownload and parse geomagnetic indices
upload_time2023-02-03 21:07:38
maintainer
docs_urlNone
authorSunip K. Mukherjee, Michael Hirsch, Ph.D.
requires_python>=3.7
license
keywords aeronomy aurora ionosphere
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # Geomagnetic Data Indices

Geomagnetic indices downloader and parser, returns Ap, F10.7 (unsmoothed and smoothed) and Kp.

This is derived from [geomagindices](https://pypi.org/project/geomagindices/), and has been modified to:

- Support the new [post-SWPC data sources for all data dating back to 1932](ftp://ftp.gfz-potsdam.de/pub/home/obs/Kp_ap_Ap_SN_F107/).
- Fix a bug where averaging would not cross year boundaries.

It is a drop-in replacement for [geomagindices](https://pypi.org/project/geomagindices/).

Output datatype is
[pandas.DataFrame](http://pandas.pydata.org/pandas-docs/stable/reference/frame.html)
(for multiple times)

internally, uses
[pandas.Index.get_loc](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Index.get_loc.html)
to find nearest time to request.

Missing data is returned as `NaN` (Not a Number floating point value).

## Installation
```sh
$ git clone https://github.com/sunipkm/geomagdata
$ cd geomagdata
$ pip install .
```

## Examples

use from other programs like

```python
import geomagdata as gi

inds = gi.get_indices(date)
```

where date is Python
[datetime.date, datetime.datetime](https://docs.python.org/3/library/datetime.html), etc.

---

```sh
python Examples/PlotIndices.py 2015-01-01 2016-01-01
```

![2015 Ap F10.7](./tests/2015.png)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sunipkm/geomagdata",
    "name": "geomagdata",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "aeronomy,aurora,ionosphere",
    "author": "Sunip K. Mukherjee, Michael Hirsch, Ph.D.",
    "author_email": "sunipkmukherjee@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/3a/9a/bb301e949adc7c3b5bba4ed75ec3626178f0a6ae4b96c3be517c46dc7b61/geomagdata-1.6.1.tar.gz",
    "platform": null,
    "description": "# Geomagnetic Data Indices\n\nGeomagnetic indices downloader and parser, returns Ap, F10.7 (unsmoothed and smoothed) and Kp.\n\nThis is derived from [geomagindices](https://pypi.org/project/geomagindices/), and has been modified to:\n\n- Support the new [post-SWPC data sources for all data dating back to 1932](ftp://ftp.gfz-potsdam.de/pub/home/obs/Kp_ap_Ap_SN_F107/).\n- Fix a bug where averaging would not cross year boundaries.\n\nIt is a drop-in replacement for [geomagindices](https://pypi.org/project/geomagindices/).\n\nOutput datatype is\n[pandas.DataFrame](http://pandas.pydata.org/pandas-docs/stable/reference/frame.html)\n(for multiple times)\n\ninternally, uses\n[pandas.Index.get_loc](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Index.get_loc.html)\nto find nearest time to request.\n\nMissing data is returned as `NaN` (Not a Number floating point value).\n\n## Installation\n```sh\n$ git clone https://github.com/sunipkm/geomagdata\n$ cd geomagdata\n$ pip install .\n```\n\n## Examples\n\nuse from other programs like\n\n```python\nimport geomagdata as gi\n\ninds = gi.get_indices(date)\n```\n\nwhere date is Python\n[datetime.date, datetime.datetime](https://docs.python.org/3/library/datetime.html), etc.\n\n---\n\n```sh\npython Examples/PlotIndices.py 2015-01-01 2016-01-01\n```\n\n![2015 Ap F10.7](./tests/2015.png)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Download and parse geomagnetic indices",
    "version": "1.6.1",
    "split_keywords": [
        "aeronomy",
        "aurora",
        "ionosphere"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3c165a4052475b9fa46193c9e96707d3d7ee7a30bced22704700d9240a8b40cd",
                "md5": "11c248ea3eb1096f9331964c4337c4ad",
                "sha256": "a3e6c8b4404245e9ec47ed7c5afae2345f49f4dbc15eaaeeaecaa542c3667738"
            },
            "downloads": -1,
            "filename": "geomagdata-1.6.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "11c248ea3eb1096f9331964c4337c4ad",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 13081,
            "upload_time": "2023-02-03T21:07:36",
            "upload_time_iso_8601": "2023-02-03T21:07:36.310543Z",
            "url": "https://files.pythonhosted.org/packages/3c/16/5a4052475b9fa46193c9e96707d3d7ee7a30bced22704700d9240a8b40cd/geomagdata-1.6.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3a9abb301e949adc7c3b5bba4ed75ec3626178f0a6ae4b96c3be517c46dc7b61",
                "md5": "ce138299ac6ef0347daa44f33577667a",
                "sha256": "3aa33ea0ea233de93fc47bef72c63ba93b339589ca09f020d1f2d5e5bcbe7665"
            },
            "downloads": -1,
            "filename": "geomagdata-1.6.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ce138299ac6ef0347daa44f33577667a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 13246,
            "upload_time": "2023-02-03T21:07:38",
            "upload_time_iso_8601": "2023-02-03T21:07:38.217941Z",
            "url": "https://files.pythonhosted.org/packages/3a/9a/bb301e949adc7c3b5bba4ed75ec3626178f0a6ae4b96c3be517c46dc7b61/geomagdata-1.6.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-03 21:07:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "sunipkm",
    "github_project": "geomagdata",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "geomagdata"
}
        
Elapsed time: 0.40650s