{
    "info": {
        "author": "MEEO s.r.l.",
        "author_email": "info@meeo.it",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: Unix",
            "Programming Language :: Python :: 3"
        ],
        "description": "\n# Documentation for Adampy_devel\n\n## Description\n\nAdampy allows to retrieve, analyze and download data hosted within the ADAM environment.\n\n## Installation Procedure\n```\nvirtualenv -p `which python3` venv\nsource venv/bin/activate\npython3 -m pip install --upgrade pip\npip3 install adampy\n```\n**********\n\n## Functions\n\n***********\n\n### getCollections\n\nThe getCollections function returns all available collections in the selected endpoint.\n\n```\nadam.getCollections(endpoint).get_data()\n```\n#### Parameters\n\n* endpoint (str) - The name of the endpoint to get the collections from.\n\n#### Returns\n\n* List with name of all collections\n\n#### Examples\n\nTo get the list of collections:\n\n```python\nimport adampy as adam\n\ncollections = adam.getCollections('wcs-eo4sdcr.adamplatform.eu').get_data()\n\nprint(collections)\n\n```\n\n------------------------------------------------------------------\n\n### getImage\n\nThe getImage function returns a numpy array containing the requested image. The image can be saved using Rasterio.\n```\nadam.getImage(endpoint, collection, time_t, min_lat = -90, max_lat = 90, min_long = -180, max_long = 180, token = 'None', geometry = 'None', masking = False, fname = 'image.tif').get_data()\n```\n\n#### Parameters\n\n* endpoint (str) - The name of the endpoint to get the collections from.\n* collection (str) - The name of the collection\n* time_t (str) - The time or time range in the format yyyy-mm-ddThh:mm:ss\n* min_lat (int or float; optional) - Minimum latitude of the bounding box (range -90 to 90)\n* max_lat (int or float; optional) - Maximum latitude of the bounding box (range -90 to 90)\n* min_long (int or float; optional) - Minimum longitude of the bounding box (range -180 to 180)\n* max_long (int or float; optional) - Maximum longitude of the bounding box (range -180 to 180)\n* token (str; optional) - Token to access restricted collections\n* geometry (shp, geojson or kml file; optional) - Geometry to mask the output image\n* masking (True or False; Default False ; optional) - Activate the masking option\n* fname (str; optional) - Name for the output file, if not stated fname = image.tif\n\n#### Returns\n\n* Numpy array with the requested image and Metadata information for the image\n\n#### Examples\n\nGet a global image for a particular time\n\n```python\nimport adampy as adam\nimport matplotlib\nimport matplotlib.pyplot as plt\n\nimage, out_meta = adam.getImage('wcs-eo4sdcr.adamplatform.eu', 'Z_CAMS_C_ECMF_PM10_4326_04','2019-03-26T00:00:00').get_data()\n\nplt.subplots(figsize=(13,13))\nplt.imshow(image)\n\n\n```\n\nGet a bounding box for a particular time\n\n```python\nimport adampy as adam\nimport matplotlib\nimport matplotlib.pyplot as plt\n\nimage, out_meta = adam.getImage('wcs-eo4sdcr.adamplatform.eu', 'Z_CAMS_C_ECMF_PM10_4326_04','2019-03-26T00:00:00',10,20,-10,50).get_data()\n\nplt.subplots(figsize=(13,13))\nplt.imshow(image)\n\n```\n\nGet a bounding box for a time range\n\n```python\nimport adampy as adam\nimport matplotlib\nimport matplotlib.pyplot as plt\n\nimage, out_meta = adam.getImage('wcs-eo4sdcr.adamplatform.eu', 'Z_CAMS_C_ECMF_PM10_4326_04','2019-03-26T00:00:00,2019-03-27T23:59:59',10,20,-10,50).get_data()\n\nplt.subplots(figsize=(13,13))\nplt.imshow(image)\n\n```\n\nGet a masked image for a time range\n\n```python\nimport adampy as adam\nimport matplotlib\nimport matplotlib.pyplot as plt\n\nimage, out_meta = adam.getImage('wcs-eo4sdcr.adamplatform.eu', 'Z_CAMS_C_ECMF_PM10_4326_04','2019-03-26T00:00:00,2019-03-27T23:59:59', geometry = 'polygon.shp', masking = True).get_data()\n\nplt.subplots(figsize=(13,13))\nplt.imshow(image)\n\n```\n-----------\n\n### getTimeSeries\n\nThe getTimeSeries function returns two arrays containing the values and time stamps for the request Latitude and Longitude location.\n```\nadam.getTimeSeries(endpoint, collection, time_t, lat, long, token = 'None').get_data()\n```\n\n#### Parameters\n\n* endpoint (str) - The name of the endpoint to get the collections from.\n* collection (str) - The name of the collection\n* time_t (str) - The time or time range in the format yyyy-mm-ddThh:mm:ss\n* lat (int or float; optional) - Minimum latitude of the bounding box (range -90 to 90)\n* long (int or float; optional) - Minimum longitude of the bounding box (range -180 to 180)\n* token (str; optional) - Token to access restricted collections\n\n#### Returns\n\n* Two arrays containing the values and time stamps for the request Latitude and Longitude location\n\n#### Examples\n\n```python\nimport adampy as adam\n\ndata, times = adam.getTimeSeries('wcs-eo4sdcr.adamplatform.eu', 'ERA-Interim_temp2m_4326_05','2014-03-26T00:00:00,2014-03-30T23:59:59', 25, 60).get_data()\n\n```\n\n-----------\n\n### getAnimation\n\nThe getAnimation function crates an animated gif of a dataset given a start and end date.\n```\nadam.getTimeSeries(endpoint, collection, start_date, end_date, min_lat = -90, max_lat = 90, min_long = -180, max_long = 180, token = 'None', frame_duration = 0.1, legend = False).get_data()\n```\n\n#### Parameters\n\n* endpoint (str) - The name of the endpoint to get the collections from.\n* collection (str) - The name of the collection\n* start_date (date object) - The start date of the animation\n* end_date (date object) - The end date of the animation\n* min_lat (int or float; optional) - Minimum latitude of the bounding box (range -90 to 90)\n* max_lat (int or float; optional) - Maximum latitude of the bounding box (range -90 to 90)\n* min_long (int or float; optional) - Minimum longitude of the bounding box (range -180 to 180)\n* max_long (int or float; optional) - Maximum longitude of the bounding box (range -180 to 180)\n* token (str; optional) - Token to access restricted collections\n* frame_duration (float or int; optional) - Frame duration in seconds\n* legend (True or False; optional) - Add legend to the animation\n\n\n#### Returns\n\n* An animated GIF of the dataset for a given start and end date.\n\n#### Examples\n\n```python\nimport adampy as adam\nfrom datetime import datetime, timedelta, date\n\nstart_date = date(2014,3,1)\nend_date = date(2014,3,5)\n\ngif_fname = adam.getAnimation('wcs-eo4sdcr.adamplatform.eu', 'NEXGDDP-pr_4326_025',start_date = start_date, end_date=end_date, frame_duration = 0.3, legend = False).get_data()\n\n```\n\n\n```python\n\n```\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://git.services.meeo.it/sistema/adampy",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "adampy",
        "package_url": "https://pypi.org/project/adampy/",
        "platform": "",
        "project_url": "https://pypi.org/project/adampy/",
        "project_urls": {
            "Homepage": "https://git.services.meeo.it/sistema/adampy"
        },
        "release_url": "https://pypi.org/project/adampy/0.0.1/",
        "requires_dist": [
            "numpy (>=1.17.2)",
            "requests (>=2.18.4)",
            "fiona (>=1.8.6)",
            "imageio (>=2.5.0)",
            "matplotlib (>=3.1.1)",
            "geopandas (>=0.5.0)",
            "xarray (>=0.13.0)",
            "datetime (>=4.0)",
            "rasterio (>=1.0.23)"
        ],
        "requires_python": ">=3.6",
        "summary": "Python Adam API",
        "version": "0.0.1"
    },
    "last_serial": 5982855,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "74c2760a41ebe3200aae38e7ea34f9c7",
                    "sha256": "d6682d2e5451f1fc1337e18b59517d42644703ef82c0519963dd5c26d2d526d9"
                },
                "downloads": -1,
                "filename": "adampy-0.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "74c2760a41ebe3200aae38e7ea34f9c7",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 8295,
                "upload_time": "2019-10-16T12:20:58",
                "url": "https://files.pythonhosted.org/packages/82/38/ef1e1586c0253ccf471c58dcb947a20ae07f7de712f51a8afdf15668ce3b/adampy-0.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6c8a38810f3a4deb36d9f6b5521cc0cc",
                    "sha256": "bb9563e90d4ecc61003232f7be286fe06d23ecae8bd0736bbbedbb2ec76ca15a"
                },
                "downloads": -1,
                "filename": "adampy-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "6c8a38810f3a4deb36d9f6b5521cc0cc",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 8769,
                "upload_time": "2019-10-16T12:21:01",
                "url": "https://files.pythonhosted.org/packages/89/d4/bc3dcceb11232b1da09bf9a905cb20d0c683f1bd25969343b9b747d17a79/adampy-0.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "74c2760a41ebe3200aae38e7ea34f9c7",
                "sha256": "d6682d2e5451f1fc1337e18b59517d42644703ef82c0519963dd5c26d2d526d9"
            },
            "downloads": -1,
            "filename": "adampy-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "74c2760a41ebe3200aae38e7ea34f9c7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 8295,
            "upload_time": "2019-10-16T12:20:58",
            "url": "https://files.pythonhosted.org/packages/82/38/ef1e1586c0253ccf471c58dcb947a20ae07f7de712f51a8afdf15668ce3b/adampy-0.0.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "6c8a38810f3a4deb36d9f6b5521cc0cc",
                "sha256": "bb9563e90d4ecc61003232f7be286fe06d23ecae8bd0736bbbedbb2ec76ca15a"
            },
            "downloads": -1,
            "filename": "adampy-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6c8a38810f3a4deb36d9f6b5521cc0cc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 8769,
            "upload_time": "2019-10-16T12:21:01",
            "url": "https://files.pythonhosted.org/packages/89/d4/bc3dcceb11232b1da09bf9a905cb20d0c683f1bd25969343b9b747d17a79/adampy-0.0.1.tar.gz"
        }
    ]
}