Metadata-Version: 2.1
Name: wtss
Version: 2.0.0a3
Summary: Python Client Library for WTSS.
Home-page: https://github.com/brazil-data-cube/wtss.py
Author: Brazil Data Cube Team
Author-email: brazildatacube@inpe.br
License: GPLv3
Keywords: Web Time Series Service,Time series,Earth Observations
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: GIS
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: Click>=7.0
Requires-Dist: geopandas>=0.12
Requires-Dist: jsonschema>=3.2
Requires-Dist: requests>=2.20
Requires-Dist: Jinja2>=2.10
Requires-Dist: python-dateutil>=2.8
Requires-Dist: Shapely>=1.8
Provides-Extra: docs
Requires-Dist: Sphinx>=2.2; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Provides-Extra: examples
Requires-Dist: matplotlib>=3.1; extra == "examples"
Requires-Dist: numpy>=1.18; extra == "examples"
Provides-Extra: tests
Requires-Dist: coverage>=4.5; extra == "tests"
Requires-Dist: pytest>=5.2; extra == "tests"
Requires-Dist: pytest-cov>=2.8; extra == "tests"
Requires-Dist: pytest-pep8>=1.0; extra == "tests"
Requires-Dist: pydocstyle>=4.0; extra == "tests"
Requires-Dist: isort>4.3; extra == "tests"
Requires-Dist: check-manifest>=0.40; extra == "tests"
Provides-Extra: matplotlib
Requires-Dist: numpy>=1.13; extra == "matplotlib"
Requires-Dist: matplotlib<4,>=3.1; extra == "matplotlib"
Provides-Extra: all
Requires-Dist: Sphinx>=2.2; extra == "all"
Requires-Dist: sphinx_rtd_theme; extra == "all"
Requires-Dist: sphinx-copybutton; extra == "all"
Requires-Dist: matplotlib>=3.1; extra == "all"
Requires-Dist: numpy>=1.18; extra == "all"
Requires-Dist: coverage>=4.5; extra == "all"
Requires-Dist: pytest>=5.2; extra == "all"
Requires-Dist: pytest-cov>=2.8; extra == "all"
Requires-Dist: pytest-pep8>=1.0; extra == "all"
Requires-Dist: pydocstyle>=4.0; extra == "all"
Requires-Dist: isort>4.3; extra == "all"
Requires-Dist: check-manifest>=0.40; extra == "all"
Requires-Dist: numpy>=1.13; extra == "all"
Requires-Dist: matplotlib<4,>=3.1; extra == "all"

..
    This file is part of Python Client Library for WTSS.
    Copyright (C) 2022 INPE.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.html>.


=================================================
Python Client Library for Web Time Series Service
=================================================


.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
        :target: https://github.com/brazil-data-cube/wtss.py/blob/master/LICENSE
        :alt: Software License


.. image:: https://readthedocs.org/projects/wtss/badge/?version=latest
        :target: https://wtss.readthedocs.io/en/latest/
        :alt: Documentation Status


.. image:: https://img.shields.io/badge/lifecycle-stable-green.svg
        :target: https://www.tidyverse.org/lifecycle/#stable
        :alt: Software Life Cycle


.. image:: https://img.shields.io/github/tag/brazil-data-cube/wtss.py.svg
        :target: https://github.com/brazil-data-cube/wtss.py/releases
        :alt: Release


.. image:: https://img.shields.io/pypi/v/wtss
        :target: https://pypi.org/project/wtss/
        :alt: Python Package Index


.. image:: https://img.shields.io/discord/689541907621085198?logo=discord&logoColor=ffffff&color=7389D8
        :target: https://discord.com/channels/689541907621085198#
        :alt: Join us at Discord


About
=====


**W**\ eb **T**\ ime **S**\ eries **S**\ ervice (WTSS) is a lightweight web service for handling time series data from remote sensing imagery. Given a location and a time interval you can retrieve the according time series as a list of real values.


In WTSS a coverage is a three dimensional array associate to spatial and temporal reference systems.


.. image:: https://raw.githubusercontent.com/brazil-data-cube/wtss.py/master/docs/sphinx/img/image-time-series.png
    :target: https://github.com/brazil-data-cube/wtss.py/blob/master/docs/sphinx/img/image-time-series.png
    :width: 240
    :alt: Coverage as a three dimensional array


WTSS is based on three operations:

- ``list_coverages``: returns the list of all available coverages in the service.

- ``describe_coverage``: returns the metadata of a given coverage.

- ``time_series``: query the database for the list of values for a given location and time interval.


If you want to know more about WTSS service, please, take a look at its `specification <https://github.com/brazil-data-cube/wtss-spec>`_.


Installation
============


Linux, macOS, and Windows users can get ``wtss`` from the `Python Package Index <https://pypi.org/project/wtss/>`_ with a recent version of ``pip``::

    pip install wtss


.. note::

    If you want to install the Matplotlib support, use the following command::

        pip install wtss[matplotlib]


Documentation
=============


See https://wtss.readthedocs.io/en/latest/.


References
==========


VINHAS, L.; QUEIROZ, G. R.; FERREIRA, K. R.; CÂMARA, G. `Web Services for Big Earth Observation Data <http://www.seer.ufu.br/index.php/revistabrasileiracartografia/article/view/44004>`_. Revista Brasileira de Cartografia, v. 69, n. 5, 18 maio 2017.


License
=======


.. admonition::
    Copyright (C) 2022 INPE.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.


..
    This file is part of Python Client Library for WTSS.
    Copyright (C) 2024 INPE.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.html>.


Changes
=======

Version 2.0.0.alpha3 (2024-09-11)
---------------------------------

- Fix time series plot related Axes object iteration (close #98)
- Fix unmapped properties `start_date` and `pixel_size` (close #105)


Version 2.0.0.alpha1 (2024-08-27)
---------------------------------

- Add support to deal with WTSS Server 2.0 (`#72 <https://github.com/brazil-data-cube/wtss.py/issues/72>`_)
- Add pagination and progress bar to retrieve time series by area (`#86 <https://github.com/brazil-data-cube/wtss.py/issues/86>`_)
- Plot time series quantile (`#84 <https://github.com/brazil-data-cube/wtss.py/issues/84>`_)
- Add way to retrieve and plot time series summarization (avg, standard_deviation, mean, etc) (`#78 <https://github.com/brazil-data-cube/wtss.py/issues/78>`_)
- Builtin way to transform time series object into GeoPandas (`#75 <https://github.com/brazil-data-cube/wtss.py/issues/75>`_)
- Scale time series (`#61 <https://github.com/brazil-data-cube/wtss.py/issues/61>`_)


Version 0.7.0 (2022-09-28)
--------------------------

- Change LICENSE to GPL v3
- Review docs and links


Version 0.7.0-3 (2021-03-29)
----------------------------


- Add the property ``common_name`` to the ``describe_coverage`` HTML representation: `#63 <https://github.com/brazil-data-cube/wtss.py/issues/63>`_.



Version 0.7.0-2 (2021-03-17)
----------------------------


- Addedd ``access token`` to the client API: `#57 <https://github.com/brazil-data-cube/wtss.py/issues/57>`_.

- Using Jinja 2 templates for Jupyter HTML output: `#51 <https://github.com/brazil-data-cube/wtss.py/issues/51>`_.

- Using Drone: `#54 <https://github.com/brazil-data-cube/wtss.py/issues/54>`_.


Version 0.7.0-1 (2020-09-14)
----------------------------


- Improved integration with Jupyter Environment: `#25 <https://github.com/brazil-data-cube/wtss.py/issues/25>`_.

- Improved ``plot`` method for ``TimeSeries``.

- Added Unit-tests.

- Fixed small typos in documentation.


Version 0.7.0-0 (2020-09-11)
----------------------------


- Basic integration with Jupyter Environment and Matplotlib.

- Command Line Interface (CLI).

- Documentation system based on Sphinx.

- Documentation integrated to ``Read the Docs``.

- Installation and build instructions.

- Package support through Setuptools.

- Installation and usage instructions.

- Travis CI support and PyPI deploy.

- Unit-test environment set.

- Source code versioning based on `Semantic Versioning 2.0.0 <https://semver.org/>`_.

- License: `MIT <https://github.com/gqueiroz/wtss.py/blob/master/LICENSE>`_.
