{
    "info": {
        "author": "Matthew Knight James",
        "author_email": "mattkjames7@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: POSIX",
            "Programming Language :: Python :: 3"
        ],
        "description": "# kpindex\nVery simple package for obtaining the planetary Kp index data (see \nhttps://www.gfz-potsdam.de/en/kp-index/ for more information)\n\n## Installation\n\nThis package depends on the following:\n\n* numpy\n* RecarrayTools\n* PyFileIO\n\nwhich are all available on PyPI.\n\nInstallation is simple and can be done in one of four ways:\n\n### Method 1\n\nThis method simply uses the Python `pip3` command to download this \nmodule and its dependencies:\n\n```pip3 install kpindex --user``` \n\n### Method 2\n\nThis method uses the Python wheel on the \"releases\" page of this \nrepository. Download the wheel, then isntall using `pip3`:\n\n```pip3 install kpindex-0.0.1-py3-none-any.whl --user```\n\n### Method 3\n\nDon't trust my prepackaged stuff? OK, clone this repository and build\nyour own:\n\n```\ngit clone https://github.com/mattkjames7/kpindex.git\ncd kpindex\npython3 setup.py bdist_wheel\npip3 install dist/kpindex-0.0.1-py3-none-any.whl --user\n```\n\n### Method 4\n\nSo you don't like wheels? Fine. Clone the repository and just move the\n\"kpindex\" folder to your `$PYTHONPATH`.\n\n## Post-Install\n\nIn order for the module to be able to download the Kp index data from\nthe FTP site, you will need to point it in the direction of a directory\nwhere you have read and write access using the `$KPDATA_PATH`\nenvironment variable. This can be done either by running the following\nin the terminal before starting Python, or inserting it into your \n`~/.bashrc` file:\n\n```\nexport KPDATA_PATH=/path/to/the/data\n```\n\n## Usage\n\nUsing this module is very simple: the first time you run it you will \nneed to update the database (also when you think the database is out of \ndate) e.g.\n\n```python\nimport kpindex\nkpindex.UpdateLocalData()\n```\n\nIt may take a couple of minutes to download the data and convert it, \nthen you are ready to read the data:\n\n```python\ndata = kpindex.GetKp(Date)\n```\n\nwhere `Date` could be `None`, in which case ALL of the Kp indices ever\nwill be returned; `Date` could be a single date in the format yyyymmdd,\nin which case only Kp indices fromt hat date will be returned; finally\nit could be a two element array/list/tuple containing two dates, in this\ncase it will return all the indices from the start to the end date.\n\n\nEnjoy!\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/mattkjames7/kpindex",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "kpindex",
        "package_url": "https://pypi.org/project/kpindex/",
        "platform": "",
        "project_url": "https://pypi.org/project/kpindex/",
        "project_urls": {
            "Homepage": "https://github.com/mattkjames7/kpindex"
        },
        "release_url": "https://pypi.org/project/kpindex/0.0.1/",
        "requires_dist": [
            "numpy",
            "RecarrayTools",
            "PyFileIO"
        ],
        "requires_python": "",
        "summary": "Very simple package for obtaining the kp index data",
        "version": "0.0.1"
    },
    "last_serial": 5050026,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "343b8ed53592b6becaea6c5a4b6f0067",
                    "sha256": "f6a27222693a366f385a6e359c602da9c12d3ec3f19d54926024d23eebe63bb6"
                },
                "downloads": -1,
                "filename": "kpindex-0.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "343b8ed53592b6becaea6c5a4b6f0067",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 12192,
                "upload_time": "2019-04-02T14:39:37",
                "url": "https://files.pythonhosted.org/packages/aa/78/df29b92e6c2e7f6c1c46122f870ebfa9a0df055ac2a75559dadc76359692/kpindex-0.0.1-py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "343b8ed53592b6becaea6c5a4b6f0067",
                "sha256": "f6a27222693a366f385a6e359c602da9c12d3ec3f19d54926024d23eebe63bb6"
            },
            "downloads": -1,
            "filename": "kpindex-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "343b8ed53592b6becaea6c5a4b6f0067",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12192,
            "upload_time": "2019-04-02T14:39:37",
            "url": "https://files.pythonhosted.org/packages/aa/78/df29b92e6c2e7f6c1c46122f870ebfa9a0df055ac2a75559dadc76359692/kpindex-0.0.1-py3-none-any.whl"
        }
    ]
}