Metadata-Version: 2.1
Name: tsblender
Version: 103.1.0
Summary: Drop-in replacement for TSPROC that is a utility for inverse modeling with PEST.
Author-email: Tim Cera <tim@cerazone.net>
License: BSD-3-Clause
Project-URL: documentation, https://timcera.bitbucket.io/tsblender/docs/index.html#tsblender-documentation
Project-URL: github, https://github.com/timcera/tsblender
Project-URL: bitbucket, https://bitbucket.org/timcera/tsblender/src/main/
Keywords: baseflow,cli-app,hydrology,parameter-estimation,python,time-series,tsproc
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: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: cltoolbox >=1.0.0
Requires-Dist: flopy
Requires-Dist: fortranformat
Requires-Dist: hspf-reader
Requires-Dist: hydrotoolbox >=2.0.0
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pint-pandas
Requires-Dist: pydantic
Requires-Dist: pyemu
Requires-Dist: python-dateutil
Requires-Dist: toolbox-utils <6.0.0,>=5.0.0
Requires-Dist: tstoolbox >=106.0.0
Requires-Dist: xlsxwriter
Provides-Extra: dev
Requires-Dist: bandit ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: blacken-docs ; extra == 'dev'
Requires-Dist: black-nbconvert ; extra == 'dev'
Requires-Dist: cleanpy ; extra == 'dev'
Requires-Dist: commitizen ; extra == 'dev'
Requires-Dist: coverage[toml] ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: pyflakes ; extra == 'dev'
Requires-Dist: pylama ; extra == 'dev'
Requires-Dist: pyle ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: pyre ; extra == 'dev'
Requires-Dist: pyroma ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-mpl ; extra == 'dev'
Requires-Dist: pyupgrade ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: unimport ; extra == 'dev'
Requires-Dist: velin ; extra == 'dev'
Requires-Dist: vulture ; extra == 'dev'

.. image:: https://github.com/timcera/tsblender/actions/workflows/python-package.yml/badge.svg
    :alt: Tests
    :target: https://github.com/timcera/tsblender/actions/workflows/python-package.yml
    :height: 20

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

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

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

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

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

tsblender - Quick Guide
=======================
The tsblender is a pure python re-write of the Time Series PROCessor (TSPROC).
When finished it will be a superset of TSPROC functionality and a more robust
and flexible tool for time series analysis.

This is not complete and is still under development.

TSPROC
------
TSPROC is a Time Series PROCessor that uses a configuration file to describe
the tasks the data scientist or modeler wants to accomplish.

Initial TSPROC development was by John Doherty, Watermark Numerical Computing.
It was part of the Surface Water Utilities package that was created to support
optimization of model parameters using the Parameter ESTimation (PEST) suite of
programs.  PEST was also developed by John Doherty.

TSPROC is written in Fortran 90 and "C" and is available from the USGS at:

:Main site: https://wi.water.usgs.gov/models/tsproc/
:Documentation: https://pubs.usgs.gov/tm/tm7c7/
:Development: https://github.com/smwesten-usgs/tsproc

Requirements
------------
* python 3.8 or higher

Installation
------------
Should be as easy as running ``pip install tsblender`` or ``conda install -c
conda-forge -c timcera tsblender`` at any command line.

Usage - Command Line
--------------------
Just run 'tsblender --help' to get a list of subcommands::


    usage: tsblender [-h]
                     {run, about) ...

    positional arguments:
      {run, about}

    about
        Display version number and system information.
    run
        Run a tsblender script file.

    optional arguments:
        -h, --help            show this help message and exit

Progress
========
This version of tsblender is INCOMPLETE.

The following blocks are only implemented in 'tsblender' and not in 'tsproc'.

     +------------------------+--------+-----------+
     | TSPROC Block Name      | tsproc | tsblender |
     +========================+========+===========+
     | GET_SERIES_GSFLOW_GAGE |        | X         |
     +------------------------+--------+-----------+
     | GET_SERIES_CSV         |        | X         |
     +------------------------+--------+-----------+
     | GET_SERIES_HSPFBIN     |        | X         |
     +------------------------+--------+-----------+
     | GET_SERIES_XLSX        |        | X         |
     +------------------------+--------+-----------+
     | COPY                   |        | X         |
     +------------------------+--------+-----------+
     | MOVE                   |        | X         |
     +------------------------+--------+-----------+
     | PLOT                   |        | X         |
     +------------------------+--------+-----------+

The following table shows the progress of the implementation of the TSPROC
blocks in 'tsblender'.

     +------------------------+--------+-----------+
     | TSPROC Block Name      | tsproc | tsblender |
     +========================+========+===========+
     | DIGITAL_FILTER         | X      |           |
     +------------------------+--------+-----------+
     | ERASE_ENTITY           | X      | X         |
     +------------------------+--------+-----------+
     | EXCEEDENCE_TIME        | X      | X         |
     +------------------------+--------+-----------+
     | FLOW_DURATION          | X      | X         |
     +------------------------+--------+-----------+
     | GET_SERIES_SSF         | X      | X         |
     +------------------------+--------+-----------+
     | GET_SERIES_STATVAR     | X      | X         |
     +------------------------+--------+-----------+
     | GET_SERIES_PLOTGEN     | X      | X         |
     +------------------------+--------+-----------+
     | GET_SERIES_TETRAD      | X      |           |
     +------------------------+--------+-----------+
     | GET_SERIES_UFORE_HYDRO | X      | X         |
     +------------------------+--------+-----------+
     | GET_SERIES_WDM         | X      | X         |
     +------------------------+--------+-----------+
     | HYDRO_EVENTS           | X      | X         |
     +------------------------+--------+-----------+
     | HYDRO_PEAKS            | X      |           |
     +------------------------+--------+-----------+
     | HYDROLOGIC_INDICES     | X      | X         |
     +------------------------+--------+-----------+
     | LIST_OUTPUT            | X      | X         |
     +------------------------+--------+-----------+
     | MOVING_MINIMUM         | X      |           |
     +------------------------+--------+-----------+
     | NEW_SERIES_UNIFORM     | X      | X         |
     +------------------------+--------+-----------+
     | NEW_TIME_BASE          | X      | X         |
     +------------------------+--------+-----------+
     | PERIOD_STATISTICS      | X      | X         |
     +------------------------+--------+-----------+
     | REDUCE_TIME_SPAN       | X      | X         |
     +------------------------+--------+-----------+
     | SERIES_BASE_LEVEL      | X      | X         |
     +------------------------+--------+-----------+
     | SERIES_CLEAN           | X      | X         |
     +------------------------+--------+-----------+
     | SERIES_COMPARE         | X      | X         |
     +------------------------+--------+-----------+
     | SERIES_DIFFERENCE      | X      | X         |
     +------------------------+--------+-----------+
     | SERIES_DISPLACE        | X      | X         |
     +------------------------+--------+-----------+
     | SERIES_EQUATION        | X      | X         |
     +------------------------+--------+-----------+
     | SERIES_STATISTICS      | X      | X         |
     +------------------------+--------+-----------+
     | SETTINGS               | X      | X         |
     +------------------------+--------+-----------+
     | USGS_HYSEP             | X      | X         |
     +------------------------+--------+-----------+
     | V_TABLE_TO_SERIES      | X      | X         |
     +------------------------+--------+-----------+
     | VOLUME_CALCULATION     | X      | X         |
     +------------------------+--------+-----------+
     | WRITE_PEST_FILES       | X      |           |
     +------------------------+--------+-----------+

The GET_MUL_SERIES_* blocks are redundant in 'tsblender' and can be
replaced by rolled up versions of the GET_SERIES_* blocks.

     +----------------------------+--------+-----------+
     | TSPROC Block Name          | tsproc | tsblender |
     +============================+========+===========+
     | GET_MUL_SERIES_GSFLOW_GAGE | X      | X         |
     +----------------------------+--------+-----------+
     | GET_MUL_SERIES_PLOTGEN     | X      | X         |
     +----------------------------+--------+-----------+
     | GET_MUL_SERIES_SSF         | X      | X         |
     +----------------------------+--------+-----------+
     | GET_MUL_SERIES_STATVAR     | X      | X         |
     +----------------------------+--------+-----------+
