Metadata-Version: 2.4
Name: tsgettoolbox_ldas
Version: 27.0.0
Summary: Plugin for tsgettoolbox to retrieve data from the Land Data Assimmilation System (LDAS) web service.
Author-email: Tim Cera <tim@cerazone.net>
License-Expression: BSD-3-Clause
Project-URL: bitbucket, https://bitbucket.org/timcera/tsgettoolbox_ldas/src/main/
Project-URL: documentation, https://timcera.bitbucket.io/tsgettoolbox/docs/index.html#tsgettoolbox-documentation
Project-URL: github, https://github.com/timcera/tsgettoolbox_ldas
Keywords: rest,time-series,uri,url,web_services
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: aiodns>3.6.0
Requires-Dist: async_retriever
Requires-Dist: pandas
Requires-Dist: pydantic>=2
Requires-Dist: requests
Requires-Dist: tabulate
Requires-Dist: tsgettoolbox>=27.0.0
Dynamic: license-file

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

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

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

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

tsgettoolbox_ldas - Quick Guide
===============================
The 'tsgettoolbox_ldas' is a plugin-in for 'tsgettoolbox' that supplies
a command line interface and Python library to get time-series data from the
California Data Exchange Center (CDEC).  The tsgettoolbox_ldas will work with
Python and 3.10+.

Documentation
-------------
Reference documentation is at `tsgettoolbox LDAS API`_.

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

    $ pip install tsgettoolbox_ldas

    OR

    $ conda install -c conda-forge tsgettoolbox_ldas

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 'ldas', type 'tsgettoolbox
ldas --help'.

+----------------------+---------+--------+---------+----------+-----------------------+
| Sub-command          | Spatial | Time   | Type    | Time     | Description           |
|                      | Extent  | Extent |         | Interval |                       |
+======================+=========+========+=========+==========+=======================+
| ldas (DEPRECATED)    | global  | varies | grid    | varies   | Land Data             |
|                      |         |        |         |          | Assimilation System   |
+----------------------+---------+--------+---------+----------+-----------------------+
| ldas_gldas_noah      | global  | 2000-  | grid    | 3H       | GLDAS NOAH hydrology  |
|                      |         |        | 0.25deg |          | model results         |
+----------------------+---------+--------+---------+----------+-----------------------+
| ldas_gldas_noah_v2_0 | global  | 1948-  | grid    | 3H       | GLDAS NOAH hydrology  |
|                      |         | 2014   | 0.25deg |          | model                 |
+----------------------+---------+--------+---------+----------+-----------------------+
| ldas_gldas_noah_v2_1 | global  | 2000-  | grid    | 3H       | GLDAS NOAH hydrology  |
|                      |         |        | 0.25deg |          | model                 |
+----------------------+---------+--------+---------+----------+-----------------------+
| ldas_grace           | NAmeric | 2002-  | grid 0. | 7D       | Groundwater and soil  |
|                      | a       |        | 125deg  |          | moisture from GRACE   |
+----------------------+---------+--------+---------+----------+-----------------------+
| ldas_merra           | global  | 1980-  | grid    | H        | MERRA-2 Land surface  |
|                      |         |        | 0.5x 0. |          |                       |
|                      |         |        | 625deg  |          |                       |
+----------------------+---------+--------+---------+----------+-----------------------+
| ldas_nldas3_forcing  | NAmeric | 2001-  | grid    | HDM      | NLDAS3 Weather        |
|                      | a       |        | 0.01deg |          | Forcing A (surface)   |
+----------------------+---------+--------+---------+----------+-----------------------+
| ldas_nldas_fora      | NAmeric | 1979-  | grid 0. | H        | NLDAS Weather Forcing |
|                      | a       |        | 125deg  |          | A (surface)           |
+----------------------+---------+--------+---------+----------+-----------------------+
| ldas_nldas_noah      | NAmeric | 1979-  | grid 0. | H        | NLDAS NOAH hydrology  |
|                      | a       |        | 125deg  |          | model                 |
+----------------------+---------+--------+---------+----------+-----------------------+
| ldas_nldas_vic       | NAmeric | 1979-  | grid 0. | H        | NLDAS VIC hydrology   |
|                      | a       |        | 125deg  |          | model                 |
+----------------------+---------+--------+---------+----------+-----------------------+
| ldas_smerge          | global  | 1997-  | grid 0. | D        | SMERGE-Noah-CCI root  |
|                      |         |        | 125deg  |          | zone soil             |
+----------------------+---------+--------+---------+----------+-----------------------+

+-------------------+-------------+
| Time Interval     | Description |
| Code              |             |
+===================+=============+
| H                 | Hourly      |
+-------------------+-------------+
| D                 | Daily       |
+-------------------+-------------+
| M                 | Monthly     |
+-------------------+-------------+

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

    from tsgettoolbox import tsgettoolbox
    df = tsgettoolbox.ldas_nldas_fora(
        34,
        100,
        variables="NLDAS_FORA0125_H_2_0_Rainf",
        startDate="2001-01-01T00",
        endDate="2001-02-02T00",
    )
    print(df.head())

Refer to the API Documentation at `tsgettoolbox LDAS API`_.

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

    tsgettoolbox ldas_nldas_fora \
        --34 \
        --100 \
        --variables="NLDAS_FORA0125_H_2_0_Rainf" \
        --startDate="2001-01-01T00" \
        --endDate="2001-02-02T00" > output.csv

Refer to the command line documentation at `tsgettoolbox LDAS API`_.

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

.. _tsgettoolbox_documentation: https://timcera.bitbucket.io/tsgettoolbox/docs/index.html#tsgettoolbox-documentation_ldas
.. _tsgettoolbox LDAS API: https://timcera.bitbucket.io/linked_pkg_dirs/tsgettoolbox/docs/_function_autosummary/tsgettoolbox.ldas.html
.. _tsgettoolbox LDAS CLI: https://timcera.bitbucket.io/linked_pkg_dirs/tsgettoolbox/docs/command_line.html#ldas
