Metadata-Version: 2.4
Name: tsgettoolbox_nldas3
Version: 27.0.0
Summary: Plugin for tsgettoolbox to access NLDAS-3 data from AWS S3.
Author-email: Tim Cera <tim@cerazone.net>
License-Expression: BSD-3-Clause
Project-URL: bitbucket, https://bitbucket.org/timcera/tsgettoolbox_nldas3/src/main/
Project-URL: documentation, https://timcera.bitbucket.io/tsgettoolbox/docs/index.html#tsgettoolbox-documentation
Project-URL: github, https://github.com/timcera/tsgettoolbox_nldas3
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: dask
Requires-Dist: fsspec
Requires-Dist: pandas
Requires-Dist: pydantic>=2
Requires-Dist: tabulate
Requires-Dist: tsgettoolbox>=27.0.0
Requires-Dist: xarray
Dynamic: license-file

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

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

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

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

tsgettoolbox_nldas3 - Quick Guide
=================================
The 'tsgettoolbox_nldas3' is a plugin-in for 'tsgettoolbox' that supplies
a command line interface and Python library to get time-series data from the
National Land Data Assimilation System version 3.  The tsgettoolbox_nldas3 will
work with Python 3.10+.

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

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

    $ pip install tsgettoolbox_nldas3

    OR

    $ conda install -c conda-forge tsgettoolbox_nldas3

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

+---------------------+----------+--------+---------+----------+-----------------------+
| Sub-command         | Spatial  | Time   | Type    | Time     | Description           |
|                     | Extent   | Extent |         | Interval |                       |
+=====================+==========+========+=========+==========+=======================+
| ldas_nldas3_forcing | NAmerica | 2001-  | grid    | HDM      | NLDAS3 Weather        |
|                     |          |        | 0.01deg |          | Forcing A (surface)   |
+---------------------+----------+--------+---------+----------+-----------------------+

+-------------------+-------------+
| 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_nldas3_forcing(
        34,
        -100,
        variables=["Tair", "Qair"],
        endDate="2002-01-01",
        time_interval="daily",
        )
    print(df.head())

Refer to the API Documentation at `tsgettoolbox_api`_.

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

    tsgettoolbox ldas_nldas3_forcing \
        34  \
        -100  \
        --variables=["Tair", "Qair"] \
        --endDate="2002-01-01" \
        --time_interval="daily" > output.csv

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

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

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