tsgettoolbox


Nametsgettoolbox JSON
Version 25.1.9 PyPI version JSON
download
home_page
SummaryWill get time series from different sources on the internet
upload_time2023-12-17 00:57:17
maintainer
docs_urlNone
author
requires_python>=3.8
licenseBSD-3-Clause
keywords rest time-series uri url web_services
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://github.com/timcera/tsgettoolbox/actions/workflows/python-package.yml/badge.svg
    :alt: Tests
    :target: https://github.com/timcera/tsgettoolbox/actions/workflows/python-package.yml
    :height: 20

.. image:: https://img.shields.io/coveralls/github/timcera/tsgettoolbox
    :alt: Test Coverage
    :target: https://coveralls.io/r/timcera/tsgettoolbox?branch=master
    :height: 20

.. image:: https://img.shields.io/pypi/v/tsgettoolbox.svg
    :alt: Latest release
    :target: https://pypi.python.org/pypi/tsgettoolbox/
    :height: 20

.. image:: https://img.shields.io/pypi/l/tsgettoolbox.svg
    :alt: BSD-3 clause license
    :target: https://pypi.python.org/pypi/tsgettoolbox/
    :height: 20

.. image:: https://img.shields.io/pypi/dd/tsgettoolbox.svg
    :alt: tsgettoolbox downloads
    :target: https://pypi.python.org/pypi/tsgettoolbox/
    :height: 20

.. image:: https://img.shields.io/pypi/pyversions/tsgettoolbox
    :alt: PyPI - Python Version
    :target: https://pypi.org/project/tsgettoolbox/
    :height: 20

tsgettoolbox - Quick Guide
==========================
The 'tsgettoolbox' is a Python script and library to get time-series data from
different web services.  The tsgettoolbox will work with Python 2.6+ and 3.0+.

Documentation
-------------
Reference documentation is at `tsgettoolbox_documentation`_.

Installation
------------
At the command line::

    $ pip install tsgettoolbox

Usage Summary - Command Line
----------------------------
Just run 'tsgettoolbox --help' to get a list of subcommands.  To get detailed
help for a particular sub-command, for instance 'coops', type 'tsgettoolbox
coops --help'.

    about
        Display version number and system information.

    cdec
        US/CA station E,H,D,M: California Department of Water Resources

    coops
        global station 1T,6T,H,D,M: Center for Operational Oceanographic
        Products and Services

    cpc
        US/region W: Climate Prediction Center, Weekly Drought Index

    daymet
        NAmerica 1km 1980- D,M:Daymet, daily meteorology by the Oak Ridge
        National Laboratory

    fawn
        US/FL 15T,H,D,M:Florida Automated Weather Network (FAWN)

    hydstra_ts
        Kisters Hydstra Webservice - time series values

    hydstra_catalog
        Kisters Hydstra Webservice - variable catalog for a station

    hydstra_stations
        Kisters Hydstra Webservice - station list for a server

    ldas
        grid: Land Data Assimilation System, includes all ldas_* (NLDAS,
        GLDAS2, TRMM, SMERGE, GRACE, MERRA)

    ldas_gldas_noah
        global 0.25deg 2000- 3H:GLDAS NOAH hydrology model results

    ldas_grace
        NAmerica 0.125deg 2002- 7D:Groundwater and soil moisture from GRACE

    ldas_merra
        global 0.5x0.625deg 1980- H:MERRA-2 Land surface forcings

    ldas_merra_update
        global 0.5x0.667deg 1980-2016 H:MERRA-2 Analysis update

    ldas_nldas_fora
        NAmerica 0.125deg 1979- H:NLDAS Weather Forcing A (surface)

    ldas_nldas_noah
        NAmerica 0.125deg 1979- H:NLDAS NOAH hydrology model results

    ldas_smerge
        global 0.125deg 1997- D:SMERGE-Noah-CCI root zone soil moisture

    ldas_trmm_tmpa
        global 0.25deg 1997- 3H:TRMM (TMPA) rainfall estimate

    metdata
        NAmerica 4km 1980- D: Download daily data from METDATA based on PRISM.

    modis
        global 250m,500m,1000m 2000- 4D,8D,16D,A:Download MODIS derived data.

    ncei_ghcnd_ftp
        global station D:NCEI Global Historical Climatology Network - Daily
        (GHCND)

    ncei_ghcnd
        global station D:Global Historical Climatology Network - Daily (GHCND)

    ncei_gsod
        global station D:NCEI Global Summary of the Day (GSOD)

    ncei_gsom
        global station M:NCEI Global Summary of Month (GSOM)

    ncei_gsoy
        global station A:NCEI Global Summary of Year (GSOY)

    ncei_normal_ann
        global station A: NCEI annual normals

    ncei_normal_dly
        global station D:NCEI Daily Normals

    ncei_normal_hly
        global station H:NCEI Normal hourly

    ncei_normal_mly
        global station M:NCEI Monthly Summaries.

    ncei_precip_15
        global station 15T:NCEI 15 minute precipitation

    ncei_precip_hly
        global station H:NCEI hourly precipitation

    ncei_annual
        global station A:NCEI annual data summaries

    ncei_ghcndms
        global station M:NCEI GHCND Monthly Summaries (GHCNDMS)

    ncei_ish
        global station H:Integrated Surface Database

    ndbc
        US station T,6T,10T,15T,H,D:Download historical from the National Data
        Buoy Center.

    nwis
        US station:Use the ``nwis_*`` functions instead.

    nwis_iv
        US station E:USGS NWIS Instantaneous Values

    nwis_dv
        US station D:USGS NWIS Daily Values

    nwis_site
        US station:USGS NWIS Site Database

    nwis_gwlevels
        US station:USGS NWIS Groundwater Levels

    nwis_measurements
        US station:USGS NWIS Measurements

    nwis_peak
        US station:USGS NWIS Peak

    nwis_stat
        US station:USGS NWIS Statistic

    epa_wqp
        US station E:EPA Water Quality Portal.

    rivergages
        US station:USACE river gages

    swtwc
        US/region station:USACE Southwest Division, Tulsa Water Control

    terraclimate
        global 1/24deg 1958- M:Download monthly data from Terraclimate.

    terraclimate2C
        global 1/24deg M:Monthly normals from Terraclimate with 2deg C hotter
        climate.

    terraclimate4C
        global 1/24deg M:Monthly normals from Terraclimate with 4deg C hotter
        climate.

    terraclimate19611990
        global 1/24deg M:Monthly normals using TerraClimate monthly data from
        1961 to 1990.

    terraclimate19812010
        global 1/24deg M:Monthly normals using TerraClimate monthly data from
        1981 to 2010.

    topowx
        US 30arcsecond 1948- M:Topoclimatic Monthly Air Temperature Dataset.

    topowx_daily
        US 30arcsecond 1948- D:Topoclimatic Daily Air Temperature Dataset.

    twc
        US/TX station D:Download Texas Weather Connection (TWC) data.

    unavco
        US station: Download data from the Unavco web services.

    usgs_flet_narr
        US/FL 2km D:USGS FL ET data from NARR meteorologic data.

    usgs_flet_stns
        US/FL 2km D:USGS FL ET data from station interpolated meteorologic
        data.

Usage Summary - Python Library
------------------------------
To use the tsgettoolbox in a project::

    from tsgettoolbox import tsgettoolbox
    df = tsgettoolbox.nwis_dv(sites="02329500", startDT="2000-01-01")

Refer to the API Documentation at `tsgettoolbox_api`_.

Usage Summary - Command Line
----------------------------

    tsgettoolbox nwis_dv --sites 02329500 --startDT 2000-01-01

Refer to the command line documentation at `tsgettoolbox_cli`_.

Development
~~~~~~~~~~~
Development is managed on bitbucket or github.
https://bitbucket.org/timcera/tsgettoolbox/overview.
https://github.com/timcera/tsgettoolbox

.. _tsgettoolbox_documentation: https://timcera.bitbucket.io/tsgettoolbox/docs/index.html#tsgettoolbox-documentation
.. _tsgettoolbox_api: https://timcera.bitbucket.io/tsgettoolbox/docs/function_summary.html
.. _tsgettoolbox_cli: https://timcera.bitbucket.io/tsgettoolbox/docs/command_line.html

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "tsgettoolbox",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "rest,time-series,uri,url,web_services",
    "author": "",
    "author_email": "Tim Cera <tim@cerazone.net>",
    "download_url": "https://files.pythonhosted.org/packages/c6/c3/bd10bd739c75d1b5f5122ce1ce5cb5160b940760bce64860bb7303b927d2/tsgettoolbox-25.1.9.tar.gz",
    "platform": null,
    "description": ".. image:: https://github.com/timcera/tsgettoolbox/actions/workflows/python-package.yml/badge.svg\n    :alt: Tests\n    :target: https://github.com/timcera/tsgettoolbox/actions/workflows/python-package.yml\n    :height: 20\n\n.. image:: https://img.shields.io/coveralls/github/timcera/tsgettoolbox\n    :alt: Test Coverage\n    :target: https://coveralls.io/r/timcera/tsgettoolbox?branch=master\n    :height: 20\n\n.. image:: https://img.shields.io/pypi/v/tsgettoolbox.svg\n    :alt: Latest release\n    :target: https://pypi.python.org/pypi/tsgettoolbox/\n    :height: 20\n\n.. image:: https://img.shields.io/pypi/l/tsgettoolbox.svg\n    :alt: BSD-3 clause license\n    :target: https://pypi.python.org/pypi/tsgettoolbox/\n    :height: 20\n\n.. image:: https://img.shields.io/pypi/dd/tsgettoolbox.svg\n    :alt: tsgettoolbox downloads\n    :target: https://pypi.python.org/pypi/tsgettoolbox/\n    :height: 20\n\n.. image:: https://img.shields.io/pypi/pyversions/tsgettoolbox\n    :alt: PyPI - Python Version\n    :target: https://pypi.org/project/tsgettoolbox/\n    :height: 20\n\ntsgettoolbox - Quick Guide\n==========================\nThe 'tsgettoolbox' is a Python script and library to get time-series data from\ndifferent web services.  The tsgettoolbox will work with Python 2.6+ and 3.0+.\n\nDocumentation\n-------------\nReference documentation is at `tsgettoolbox_documentation`_.\n\nInstallation\n------------\nAt the command line::\n\n    $ pip install tsgettoolbox\n\nUsage Summary - Command Line\n----------------------------\nJust run 'tsgettoolbox --help' to get a list of subcommands.  To get detailed\nhelp for a particular sub-command, for instance 'coops', type 'tsgettoolbox\ncoops --help'.\n\n    about\n        Display version number and system information.\n\n    cdec\n        US/CA station E,H,D,M: California Department of Water Resources\n\n    coops\n        global station 1T,6T,H,D,M: Center for Operational Oceanographic\n        Products and Services\n\n    cpc\n        US/region W: Climate Prediction Center, Weekly Drought Index\n\n    daymet\n        NAmerica 1km 1980- D,M:Daymet, daily meteorology by the Oak Ridge\n        National Laboratory\n\n    fawn\n        US/FL 15T,H,D,M:Florida Automated Weather Network (FAWN)\n\n    hydstra_ts\n        Kisters Hydstra Webservice - time series values\n\n    hydstra_catalog\n        Kisters Hydstra Webservice - variable catalog for a station\n\n    hydstra_stations\n        Kisters Hydstra Webservice - station list for a server\n\n    ldas\n        grid: Land Data Assimilation System, includes all ldas_* (NLDAS,\n        GLDAS2, TRMM, SMERGE, GRACE, MERRA)\n\n    ldas_gldas_noah\n        global 0.25deg 2000- 3H:GLDAS NOAH hydrology model results\n\n    ldas_grace\n        NAmerica 0.125deg 2002- 7D:Groundwater and soil moisture from GRACE\n\n    ldas_merra\n        global 0.5x0.625deg 1980- H:MERRA-2 Land surface forcings\n\n    ldas_merra_update\n        global 0.5x0.667deg 1980-2016 H:MERRA-2 Analysis update\n\n    ldas_nldas_fora\n        NAmerica 0.125deg 1979- H:NLDAS Weather Forcing A (surface)\n\n    ldas_nldas_noah\n        NAmerica 0.125deg 1979- H:NLDAS NOAH hydrology model results\n\n    ldas_smerge\n        global 0.125deg 1997- D:SMERGE-Noah-CCI root zone soil moisture\n\n    ldas_trmm_tmpa\n        global 0.25deg 1997- 3H:TRMM (TMPA) rainfall estimate\n\n    metdata\n        NAmerica 4km 1980- D: Download daily data from METDATA based on PRISM.\n\n    modis\n        global 250m,500m,1000m 2000- 4D,8D,16D,A:Download MODIS derived data.\n\n    ncei_ghcnd_ftp\n        global station D:NCEI Global Historical Climatology Network - Daily\n        (GHCND)\n\n    ncei_ghcnd\n        global station D:Global Historical Climatology Network - Daily (GHCND)\n\n    ncei_gsod\n        global station D:NCEI Global Summary of the Day (GSOD)\n\n    ncei_gsom\n        global station M:NCEI Global Summary of Month (GSOM)\n\n    ncei_gsoy\n        global station A:NCEI Global Summary of Year (GSOY)\n\n    ncei_normal_ann\n        global station A: NCEI annual normals\n\n    ncei_normal_dly\n        global station D:NCEI Daily Normals\n\n    ncei_normal_hly\n        global station H:NCEI Normal hourly\n\n    ncei_normal_mly\n        global station M:NCEI Monthly Summaries.\n\n    ncei_precip_15\n        global station 15T:NCEI 15 minute precipitation\n\n    ncei_precip_hly\n        global station H:NCEI hourly precipitation\n\n    ncei_annual\n        global station A:NCEI annual data summaries\n\n    ncei_ghcndms\n        global station M:NCEI GHCND Monthly Summaries (GHCNDMS)\n\n    ncei_ish\n        global station H:Integrated Surface Database\n\n    ndbc\n        US station T,6T,10T,15T,H,D:Download historical from the National Data\n        Buoy Center.\n\n    nwis\n        US station:Use the ``nwis_*`` functions instead.\n\n    nwis_iv\n        US station E:USGS NWIS Instantaneous Values\n\n    nwis_dv\n        US station D:USGS NWIS Daily Values\n\n    nwis_site\n        US station:USGS NWIS Site Database\n\n    nwis_gwlevels\n        US station:USGS NWIS Groundwater Levels\n\n    nwis_measurements\n        US station:USGS NWIS Measurements\n\n    nwis_peak\n        US station:USGS NWIS Peak\n\n    nwis_stat\n        US station:USGS NWIS Statistic\n\n    epa_wqp\n        US station E:EPA Water Quality Portal.\n\n    rivergages\n        US station:USACE river gages\n\n    swtwc\n        US/region station:USACE Southwest Division, Tulsa Water Control\n\n    terraclimate\n        global 1/24deg 1958- M:Download monthly data from Terraclimate.\n\n    terraclimate2C\n        global 1/24deg M:Monthly normals from Terraclimate with 2deg C hotter\n        climate.\n\n    terraclimate4C\n        global 1/24deg M:Monthly normals from Terraclimate with 4deg C hotter\n        climate.\n\n    terraclimate19611990\n        global 1/24deg M:Monthly normals using TerraClimate monthly data from\n        1961 to 1990.\n\n    terraclimate19812010\n        global 1/24deg M:Monthly normals using TerraClimate monthly data from\n        1981 to 2010.\n\n    topowx\n        US 30arcsecond 1948- M:Topoclimatic Monthly Air Temperature Dataset.\n\n    topowx_daily\n        US 30arcsecond 1948- D:Topoclimatic Daily Air Temperature Dataset.\n\n    twc\n        US/TX station D:Download Texas Weather Connection (TWC) data.\n\n    unavco\n        US station: Download data from the Unavco web services.\n\n    usgs_flet_narr\n        US/FL 2km D:USGS FL ET data from NARR meteorologic data.\n\n    usgs_flet_stns\n        US/FL 2km D:USGS FL ET data from station interpolated meteorologic\n        data.\n\nUsage Summary - Python Library\n------------------------------\nTo use the tsgettoolbox in a project::\n\n    from tsgettoolbox import tsgettoolbox\n    df = tsgettoolbox.nwis_dv(sites=\"02329500\", startDT=\"2000-01-01\")\n\nRefer to the API Documentation at `tsgettoolbox_api`_.\n\nUsage Summary - Command Line\n----------------------------\n\n    tsgettoolbox nwis_dv --sites 02329500 --startDT 2000-01-01\n\nRefer to the command line documentation at `tsgettoolbox_cli`_.\n\nDevelopment\n~~~~~~~~~~~\nDevelopment is managed on bitbucket or github.\nhttps://bitbucket.org/timcera/tsgettoolbox/overview.\nhttps://github.com/timcera/tsgettoolbox\n\n.. _tsgettoolbox_documentation: https://timcera.bitbucket.io/tsgettoolbox/docs/index.html#tsgettoolbox-documentation\n.. _tsgettoolbox_api: https://timcera.bitbucket.io/tsgettoolbox/docs/function_summary.html\n.. _tsgettoolbox_cli: https://timcera.bitbucket.io/tsgettoolbox/docs/command_line.html\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Will get time series from different sources on the internet",
    "version": "25.1.9",
    "project_urls": {
        "bitbucket": "https://bitbucket.org/timcera/tsgettoolbox/src/main/",
        "documentation": "https://timcera.bitbucket.io/tsgettoolbox/docs/index.html#tsgettoolbox-documentation",
        "github": "https://github.com/timcera/tsgettoolbox"
    },
    "split_keywords": [
        "rest",
        "time-series",
        "uri",
        "url",
        "web_services"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c6c3bd10bd739c75d1b5f5122ce1ce5cb5160b940760bce64860bb7303b927d2",
                "md5": "14f8f3b531f8a4c6332965ab7c0481aa",
                "sha256": "2e0c5346c805988be44001dd64e8e11f1f1761646afd82a3326d0a45fbda7594"
            },
            "downloads": -1,
            "filename": "tsgettoolbox-25.1.9.tar.gz",
            "has_sig": false,
            "md5_digest": "14f8f3b531f8a4c6332965ab7c0481aa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 94342492,
            "upload_time": "2023-12-17T00:57:17",
            "upload_time_iso_8601": "2023-12-17T00:57:17.501901Z",
            "url": "https://files.pythonhosted.org/packages/c6/c3/bd10bd739c75d1b5f5122ce1ce5cb5160b940760bce64860bb7303b927d2/tsgettoolbox-25.1.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-17 00:57:17",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "timcera",
    "github_project": "tsgettoolbox",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tsgettoolbox"
}
        
Elapsed time: 0.16449s