{
    "info": {
        "author": "W. Brown",
        "author_email": "wb@bgs.ac.uk",
        "bugtrack_url": null,
        "classifiers": [
            "Programming Language :: Python :: 3"
        ],
        "description": "# gmdata_webinterface\n[![Build Status](https://travis-ci.org/willjbrown88/geomag_wdc_web_app_interface.svg?branch=master)](https://travis-ci.org/willjbrown88/geomag_wdc_web_app_interface)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\nThis Python package allows a users to programmatically download data from the\n[British Geological Survey (BGS) Data Portal to the World Data Centre (WDC)\nfor geomagnetism, Edinburgh](http://wdc.bgs.ac.uk/dataportal/).\n\nCurrently hour and minute cadence WDC files from geomagnetic observatories\ncan be downloaded in this manner.\n\nThis code was originally developed by Laurence Billingham, and is now maintained\nby William Brown.\n\n### MagPySV\nThis package was designed in part to support observatory secular variation data processing work\nof Grace Cox in `MagPySV` (see [Grace's GitHub repo](https://github.com/gracecox/MagPySV/)),\nwhich will install this project as a dependecy to fetch WDC data on demand.\n\n## Installation\nThe latest official release of the package can be installed from the Python Package\nIndex PyPI with\n`pip install gmdata_webinterface`.\n\nThe latest working version of the package can also be installed directly from git with:\n`pip install git+https://github.com/willjbrown88/geomag_wdc_web_app_interface.git`\n\n## Usage\nThe main function for getting data is `consume_webservices.fetch_data()`.\n\n### Example usage:\n```python\nfrom datetime import date\nfrom gmdata_webinterface import consume_webservices as cws\n\ncadence = 'hour'\nstations = ['ESK', 'LER']\nstart_date = date(2015, 4, 1)\nend_date = date(2015, 4, 30)\nservice = 'WDC'\ndownload_dir = '/tmp/'\ncws.fetch_data(\n        start_date=start_date, end_date=end_date,\n        station_list=stations, cadence=cadence,\n        service=service, saveroot=download_dir\n)\n```\nSee the docstring on `fetch_data` and the test in\n`gmdata_webinterface/tests/functional_tests.test_fetch_data_wdc_format_hour_data_from_wdc`\nfor detailed useage.\nThis will download all available hourly data housed in the WDC for Geomagnetism,\nEdinburgh, for dates between `start_date` and `end_date`, from 'ESK'(dalemuir) and\n'LER'(wick) observatories, to the directory '/tmp/'.\n\n## Contributing\nThis is a working project, with open source under an MIT license. You can report\nbugs, suggest changes, and contribute to this project via github at\nhttps://github.com/willjbrown88/geomag_wdc_web_app_interface.\n\nExpansion of the current package to access other ground observatory data services,\nsuch as INTERMAGNET and the AUX_OBS_ product of the ESA Swarm mission, are currently\nbeing developed. Any contributions or suggestion are welcome.\n\n### Source code install\nYou can obtain the source code from github with e.g.:\n`git clone https://github.com/willjbrown88/geomag_wdc_web_app_interface.git ./my_source_dir/`\nThe code can then be built, documented and tested in various ways with the make `make` command,\nwhen in the source code directory.\nType `make help` in the source directory to see the available options, e.g.\n\n  * To install the package from source use:\n    `make install`\n\n  * To install in editable, development mode use:\n    `make develop`\n\n  * To run the unit tests:\n    `make test`\n\n  * To build the html documentation:\n    `make docs`\n\n## Reference\nA manuscript describing [MagPySV](https://github.com/gracecox/MagPySV) and the\nintergated functionality of this package is currently in preparation.\n\nWhile the project is open source, we ask that you abide by the included MIT license,\nand acknowledge the authors where due.",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/willjbrown88/geomag_wdc_web_app_interface",
        "keywords": "geomagnetism,geomagnetic observatory data,wdc,intermagnet",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "gmdata-webinterface",
        "package_url": "https://pypi.org/project/gmdata-webinterface/",
        "platform": "",
        "project_url": "https://pypi.org/project/gmdata-webinterface/",
        "project_urls": {
            "Homepage": "https://github.com/willjbrown88/geomag_wdc_web_app_interface"
        },
        "release_url": "https://pypi.org/project/gmdata-webinterface/1.0.8/",
        "requires_dist": null,
        "requires_python": ">=3.4",
        "summary": "Retrieve geomagnetic observatory data via web services",
        "version": "1.0.8"
    },
    "last_serial": 4256902,
    "releases": {
        "1.0.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "36c2adb0dd1cea3ae23011e0da41298c",
                    "sha256": "31efd3974367059fbf91cb1523acb17d32e9ae6eeaf36a24ac0876463b94ae86"
                },
                "downloads": -1,
                "filename": "gmdata_webinterface-1.0.7.tar.gz",
                "has_sig": false,
                "md5_digest": "36c2adb0dd1cea3ae23011e0da41298c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.4",
                "size": 2601350,
                "upload_time": "2018-04-20T08:59:11",
                "url": "https://files.pythonhosted.org/packages/12/c7/2dbf38ff5fabab3a23ee85db0f78fca1d18311bff68a466f87b1409ff62a/gmdata_webinterface-1.0.7.tar.gz"
            }
        ],
        "1.0.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0c84ffc2e518f953b3784f0eaf58f7d8",
                    "sha256": "6f39092e12478690d5d8438fa6ad061cb60f695f92d438ab74bdfff5addab58f"
                },
                "downloads": -1,
                "filename": "gmdata_webinterface-1.0.8.tar.gz",
                "has_sig": false,
                "md5_digest": "0c84ffc2e518f953b3784f0eaf58f7d8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.4",
                "size": 2601383,
                "upload_time": "2018-09-10T09:20:04",
                "url": "https://files.pythonhosted.org/packages/a8/9b/03c63541bddb2775f8dfaaf465c965715e25f28df35543a262ac781c002e/gmdata_webinterface-1.0.8.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0c84ffc2e518f953b3784f0eaf58f7d8",
                "sha256": "6f39092e12478690d5d8438fa6ad061cb60f695f92d438ab74bdfff5addab58f"
            },
            "downloads": -1,
            "filename": "gmdata_webinterface-1.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "0c84ffc2e518f953b3784f0eaf58f7d8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.4",
            "size": 2601383,
            "upload_time": "2018-09-10T09:20:04",
            "url": "https://files.pythonhosted.org/packages/a8/9b/03c63541bddb2775f8dfaaf465c965715e25f28df35543a262ac781c002e/gmdata_webinterface-1.0.8.tar.gz"
        }
    ]
}