pastas


Namepastas JSON
Version 1.4.0 PyPI version JSON
download
home_page
SummaryPastas is an open-source Python framework for the analysis of groundwater time series.
upload_time2024-02-20 10:32:26
maintainer
docs_urlNone
authorCollenteur et al. 2019
requires_python>=3.8
licenseThe MIT License (MIT) Copyright (c) 2016-2021 R.A. Collenteur, M. Bakker, R. Calje, F. Schaars Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords hydrology groundwater timeseries analysis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Pastas: Analysis of Groundwater Time Series
===========================================

.. image:: /doc/_static/logo_small.png
   :width: 200px
   :align: left

.. image:: https://github.com/pastas/pastas/actions/workflows/ci.yml/badge.svg?branch=master
   :target: https://github.com/pastas/pastas/actions/workflows/ci.yml
.. image:: https://img.shields.io/pypi/v/pastas.svg
   :target: https://pypi.python.org/pypi/pastas
.. image:: https://img.shields.io/pypi/l/pastas.svg
   :target: https://mit-license.org/
.. image:: https://img.shields.io/pypi/pyversions/pastas
   :target: https://pypi.python.org/pypi/pastas
.. image:: https://img.shields.io/pypi/dm/pastas
   :target: https://pypi.org/project/pastas/
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1465866.svg
   :target: https://doi.org/10.5281/zenodo.1465866
.. image:: https://app.codacy.com/project/badge/Grade/952f41c453854064ba0ee1fa0a0b4434
   :target: https://app.codacy.com/gh/pastas/pastas/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
.. image:: https://api.codacy.com/project/badge/Coverage/952f41c453854064ba0ee1fa0a0b4434
   :target: https://app.codacy.com/gh/pastas/pastas/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage9
.. image:: https://readthedocs.org/projects/pastas/badge/?version=latest
   :target: https://pastas.readthedocs.io/en/latest/?badge=latest
.. image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/pastas/pastas/master?filepath=examples%2Fnotebooks%2F1_basic_model.ipynb

Pastas: what is it?
~~~~~~~~~~~~~~~~~~~
Pastas is an open source python package for processing, simulating and analyzing
groundwater time series. The object oriented structure allows for the quick
implementation of new model components. Time series models can be created,
calibrated, and analysed with just a few lines of python code with the
built-in optimization, visualisation, and statistical analysis tools.

Documentation & Examples
~~~~~~~~~~~~~~~~~~~~~~~~
- Documentation is provided on the dedicated website `pastas.dev <http://www.pastas.dev/>`_
- Examples can be found on the `examples directory on the documentation website <https://pastas.readthedocs.io/en/dev/examples/index.html>`_
- View and edit a working example notebook of a Pastas model in `MyBinder <https://mybinder.org/v2/gh/pastas/pastas/master?filepath=examples%2Fnotebooks%2F1_basic_model.ipynb>`_
- A list of publications that use Pastas is available in a `dedicated Zotero group <https://www.zotero.org/groups/4846685/pastas/items/32FS5PTW/item-list>`_

Get in Touch
~~~~~~~~~~~~
- Questions on Pastas can be asked and answered on `Github Discussions <https://github.com/pastas/pastas/discussions>`_.
- Bugs, feature requests and other improvements can be posted as `Github Issues <https://github.com/pastas/pastas/issues>`_.
- Pull requests will only be accepted on the development branch (dev) of
  this repository. Please take a look at the `developers section
  <http://pastas.readthedocs.io/>`_ on the documentation website for more
  information on how to contribute to Pastas.

Quick installation guide
~~~~~~~~~~~~~~~~~~~~~~~~
To install Pastas, a working version of Python 3.8, 3.9, 3.10, 3.11 has to be
installed on your computer. We recommend using the `Anaconda Distribution
<https://www.continuum.io/downloads>`_ as it includes most of the python
package dependencies and the Jupyter Notebook software to run the notebooks.
However, you are free to install any Python distribution you want.

Stable version
--------------
To get the latest stable version, use::

  pip install pastas

Update
------
To update pastas, use::

  pip install pastas --upgrade

Developers
----------
To get the latest development version, use::

   pip install git+https://github.com/pastas/pastas.git@dev#egg=pastas

Related packages
~~~~~~~~~~~~~~~~
- `Pastastore <https://github.com/pastas/pastastore>`_ is a Python package for managing multiple timeseries and pastas models
- `Metran <https://github.com/pastas/metran>`_ is a Python package to perform multivariate timeseries analysis using a technique called dynamic factor modelling.
- `Hydropandas <https://github.com/ArtesiaWater/hydropandas/blob/master/examples/03_hydropandas_and_pastas.ipynb>`_ can be used to obtain Dutch timeseries (KNMI, Dinoloket, ..)
- `PyEt <https://github.com/phydrus/pyet>`_ can be used to compute potential evaporation from meteorological variables.

Dependencies
~~~~~~~~~~~~
Pastas depends on a number of Python packages, of which all of the necessary
are automatically installed when using the pip install manager. To
summarize, the dependencies necessary for a minimal function installation of
Pastas

- numpy>=1.7
- matplotlib>=3.1
- pandas>=1.1
- scipy>=1.8
- numba>=0.51

To install the most important optional dependencies (solver LmFit and function visualisation Latexify) at the same time with Pastas use::

   pip install pastas[full]

or for the development version use::

   pip install git+https://github.com/pastas/pastas.git@dev#egg=pastas[full]

How to Cite Pastas?
~~~~~~~~~~~~~~~~~~~
If you use Pastas in one of your studies, please cite the Pastas article in Groundwater:

- Collenteur, R.A., Bakker, M., Caljé, R., Klop, S.A., Schaars, F. (2019) `Pastas: open source software for the analysis of groundwater time series <https://ngwa.onlinelibrary.wiley.com/doi/abs/10.1111/gwat.12925>`_. Groundwater. doi: 10.1111/gwat.12925.

To cite a specific version of Python, you can use the DOI provided for each official release (>0.9.7) through Zenodo. Click on the link to get a specific version and DOI, depending on the Pastas version.

- Collenteur, R., Bakker, M., Caljé, R. & Schaars, F. (XXXX). Pastas: open-source software for time series analysis in hydrology (Version X.X.X). Zenodo. http://doi.org/10.5281/zenodo.1465866


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pastas",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "\"R.A. Collenteur\" <raoulcollenteur@gmail.com>, \"M. Bakker\" <markbak@gmail.com>, \"R. Calje\" <r.calje@artesia-water.nl>, \"F. Schaars\" <f.schaars@artesia-water.nl>, \"D.A. Brakenhoff\" <d.brakenhoff@artesia-water.nl>, \"O.N. Ebbens\" <o.ebbens@artesia-water.nl>, \"M.A. Vonk\" <vonk.mart@gmail.com>",
    "keywords": "hydrology,groundwater,timeseries,analysis",
    "author": "Collenteur et al. 2019",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/2b/c2/f71045c19906ad29b6da570706d0b14e52cd0fa71a2226aa2f6efc81524d/pastas-1.4.0.tar.gz",
    "platform": null,
    "description": "Pastas: Analysis of Groundwater Time Series\n===========================================\n\n.. image:: /doc/_static/logo_small.png\n   :width: 200px\n   :align: left\n\n.. image:: https://github.com/pastas/pastas/actions/workflows/ci.yml/badge.svg?branch=master\n   :target: https://github.com/pastas/pastas/actions/workflows/ci.yml\n.. image:: https://img.shields.io/pypi/v/pastas.svg\n   :target: https://pypi.python.org/pypi/pastas\n.. image:: https://img.shields.io/pypi/l/pastas.svg\n   :target: https://mit-license.org/\n.. image:: https://img.shields.io/pypi/pyversions/pastas\n   :target: https://pypi.python.org/pypi/pastas\n.. image:: https://img.shields.io/pypi/dm/pastas\n   :target: https://pypi.org/project/pastas/\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1465866.svg\n   :target: https://doi.org/10.5281/zenodo.1465866\n.. image:: https://app.codacy.com/project/badge/Grade/952f41c453854064ba0ee1fa0a0b4434\n   :target: https://app.codacy.com/gh/pastas/pastas/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade\n.. image:: https://api.codacy.com/project/badge/Coverage/952f41c453854064ba0ee1fa0a0b4434\n   :target: https://app.codacy.com/gh/pastas/pastas/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage9\n.. image:: https://readthedocs.org/projects/pastas/badge/?version=latest\n   :target: https://pastas.readthedocs.io/en/latest/?badge=latest\n.. image:: https://mybinder.org/badge_logo.svg\n   :target: https://mybinder.org/v2/gh/pastas/pastas/master?filepath=examples%2Fnotebooks%2F1_basic_model.ipynb\n\nPastas: what is it?\n~~~~~~~~~~~~~~~~~~~\nPastas is an open source python package for processing, simulating and analyzing\ngroundwater time series. The object oriented structure allows for the quick\nimplementation of new model components. Time series models can be created,\ncalibrated, and analysed with just a few lines of python code with the\nbuilt-in optimization, visualisation, and statistical analysis tools.\n\nDocumentation & Examples\n~~~~~~~~~~~~~~~~~~~~~~~~\n- Documentation is provided on the dedicated website `pastas.dev <http://www.pastas.dev/>`_\n- Examples can be found on the `examples directory on the documentation website <https://pastas.readthedocs.io/en/dev/examples/index.html>`_\n- View and edit a working example notebook of a Pastas model in `MyBinder <https://mybinder.org/v2/gh/pastas/pastas/master?filepath=examples%2Fnotebooks%2F1_basic_model.ipynb>`_\n- A list of publications that use Pastas is available in a `dedicated Zotero group <https://www.zotero.org/groups/4846685/pastas/items/32FS5PTW/item-list>`_\n\nGet in Touch\n~~~~~~~~~~~~\n- Questions on Pastas can be asked and answered on `Github Discussions <https://github.com/pastas/pastas/discussions>`_.\n- Bugs, feature requests and other improvements can be posted as `Github Issues <https://github.com/pastas/pastas/issues>`_.\n- Pull requests will only be accepted on the development branch (dev) of\n  this repository. Please take a look at the `developers section\n  <http://pastas.readthedocs.io/>`_ on the documentation website for more\n  information on how to contribute to Pastas.\n\nQuick installation guide\n~~~~~~~~~~~~~~~~~~~~~~~~\nTo install Pastas, a working version of Python 3.8, 3.9, 3.10, 3.11 has to be\ninstalled on your computer. We recommend using the `Anaconda Distribution\n<https://www.continuum.io/downloads>`_ as it includes most of the python\npackage dependencies and the Jupyter Notebook software to run the notebooks.\nHowever, you are free to install any Python distribution you want.\n\nStable version\n--------------\nTo get the latest stable version, use::\n\n  pip install pastas\n\nUpdate\n------\nTo update pastas, use::\n\n  pip install pastas --upgrade\n\nDevelopers\n----------\nTo get the latest development version, use::\n\n   pip install git+https://github.com/pastas/pastas.git@dev#egg=pastas\n\nRelated packages\n~~~~~~~~~~~~~~~~\n- `Pastastore <https://github.com/pastas/pastastore>`_ is a Python package for managing multiple timeseries and pastas models\n- `Metran <https://github.com/pastas/metran>`_ is a Python package to perform multivariate timeseries analysis using a technique called dynamic factor modelling.\n- `Hydropandas <https://github.com/ArtesiaWater/hydropandas/blob/master/examples/03_hydropandas_and_pastas.ipynb>`_ can be used to obtain Dutch timeseries (KNMI, Dinoloket, ..)\n- `PyEt <https://github.com/phydrus/pyet>`_ can be used to compute potential evaporation from meteorological variables.\n\nDependencies\n~~~~~~~~~~~~\nPastas depends on a number of Python packages, of which all of the necessary\nare automatically installed when using the pip install manager. To\nsummarize, the dependencies necessary for a minimal function installation of\nPastas\n\n- numpy>=1.7\n- matplotlib>=3.1\n- pandas>=1.1\n- scipy>=1.8\n- numba>=0.51\n\nTo install the most important optional dependencies (solver LmFit and function visualisation Latexify) at the same time with Pastas use::\n\n   pip install pastas[full]\n\nor for the development version use::\n\n   pip install git+https://github.com/pastas/pastas.git@dev#egg=pastas[full]\n\nHow to Cite Pastas?\n~~~~~~~~~~~~~~~~~~~\nIf you use Pastas in one of your studies, please cite the Pastas article in Groundwater:\n\n- Collenteur, R.A., Bakker, M., Calj\u00e9, R., Klop, S.A., Schaars, F. (2019) `Pastas: open source software for the analysis of groundwater time series <https://ngwa.onlinelibrary.wiley.com/doi/abs/10.1111/gwat.12925>`_. Groundwater. doi: 10.1111/gwat.12925.\n\nTo cite a specific version of Python, you can use the DOI provided for each official release (>0.9.7) through Zenodo. Click on the link to get a specific version and DOI, depending on the Pastas version.\n\n- Collenteur, R., Bakker, M., Calj\u00e9, R. & Schaars, F. (XXXX). Pastas: open-source software for time series analysis in hydrology (Version X.X.X). Zenodo. http://doi.org/10.5281/zenodo.1465866\n\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)  Copyright (c) 2016-2021 R.A. Collenteur, M. Bakker, R. Calje, F. Schaars  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Pastas is an open-source Python framework for the analysis of groundwater time series.",
    "version": "1.4.0",
    "project_urls": {
        "documentation": "https://pastas.readthedocs.io/en/latest/",
        "homepage": "https://pastas.dev",
        "repository": "https://github.com/pastas/pastas"
    },
    "split_keywords": [
        "hydrology",
        "groundwater",
        "timeseries",
        "analysis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "975e6b1a9aaa37e93c13437c78e3f67fcd87a9d72b827d831bdbed497bf30cb8",
                "md5": "2d2bff0940b6117509505c0a3b15b75e",
                "sha256": "c50cbb8efc16579c85fd404c2a815e353a121259302f45a8ec04e2932e40de27"
            },
            "downloads": -1,
            "filename": "pastas-1.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2d2bff0940b6117509505c0a3b15b75e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 147461,
            "upload_time": "2024-02-20T10:32:25",
            "upload_time_iso_8601": "2024-02-20T10:32:25.225181Z",
            "url": "https://files.pythonhosted.org/packages/97/5e/6b1a9aaa37e93c13437c78e3f67fcd87a9d72b827d831bdbed497bf30cb8/pastas-1.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2bc2f71045c19906ad29b6da570706d0b14e52cd0fa71a2226aa2f6efc81524d",
                "md5": "1af89d6d4c1affdb28b0f801c119dd10",
                "sha256": "9159bd6f82ca85532d6f145ec75ba363701d83f8692e83d65bf4cffd154785ac"
            },
            "downloads": -1,
            "filename": "pastas-1.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1af89d6d4c1affdb28b0f801c119dd10",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 142939,
            "upload_time": "2024-02-20T10:32:26",
            "upload_time_iso_8601": "2024-02-20T10:32:26.974164Z",
            "url": "https://files.pythonhosted.org/packages/2b/c2/f71045c19906ad29b6da570706d0b14e52cd0fa71a2226aa2f6efc81524d/pastas-1.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-20 10:32:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pastas",
    "github_project": "pastas",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pastas"
}
        
Elapsed time: 0.19118s