Pygoda
======
*The Swiss Army Knife of Geolocated Time Series Visualisation*

Release v\ |version|. (:ref:`Installation <install>`)

.. image:: https://img.shields.io/badge/licence-EUPL--v1.2-brightgreen
    :target: https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
    :alt: EUPL-v1.2 Licence Badge

Pygoda is a Python GUI to visualise and analyse efficiently large sets of geolocated time series observed, recorded or computed at different locations on the Earth.

It is developed and maintained by Yann Ziegler @ `University of Bristol <https://www.bristol.ac.uk/>`_ (UK), `School of Geographical Sciences <https://www.bristol.ac.uk/geography/>`_, `Bristol Glaciology Centre <https://www.bristol.ac.uk/geography/research/bgc/>`_

This work is part of the `GlobalMass project <https://www.globalmass.eu/>`_.

-------------------

.. image:: https://github.com/yannziegler/Pygoda/raw/master/pygoda/data/pygoda.png
    :alt: Pygoda screenshot

*Pygoda* means any of the following, depending on your preference:

- PYthon for GeOreferenceD time series visualisation and Analysis, or
- PYthon for GeOlocated Data Analysis, or my personal favourite
- PYthon for GeOlocated time series DiAgnosis

Tasty Features
--------------

- Spatio-temporal visualisation
- Visualise tens of time series at once
- Optimised modal GUI
- Load many data format
- Extract or compute time series features
- Fit standard models
- Sort and filter
- Geographic data selection
- Handy t- and y-range customisation
- Colourful categories
- Online map layers
- Customisable theme

A (roughly) exhaustive :ref:`list of features <features>` is available.

User Guide
----------

.. toctree::
   :maxdepth: 2

   user/install
   user/quickstart
   user/howto

General Information
-------------------

.. toctree::
   :maxdepth: 2

   info/faq
   info/features
   info/dataformat
   info/limitations
   info/roadmap
   info/history
   info/media

Scientific Background
---------------------

.. toctree::
   :maxdepth: 2

   sci/manuscript
   sci/talkposters
   sci/inthewild
   sci/theory
   sci/howtocite

API (for contributors only)
---------------------------

For now, Pygoda does not come with an official public API.
The only way to use the software is through its GUI.

An API documentation is provided for contributors, though.

.. toctree:
   :maxdepth: 2

   api

Contributor Guide
-----------------

.. toctree::
   :maxdepth: 2

   dev/contributing
   dev/authors