pastas-plugins


Namepastas-plugins JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryRepository containing plugins to further enhance your pastas experience.
upload_time2024-08-16 12:23:04
maintainerNone
docs_urlNone
authorPastas Developers Team
requires_python>=3.9
licenseMIT License Copyright (c) 2024 Pastas 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-plugins

Welcome to the pastas-plugins repository, your one-stop-shop for customized
cutting-edge additions to Pastas.


## Current plugins

The following plugins are now available:

- **`cross_correlation`**: analyze and visualize the cross-correlation between two time series.
- **`modflow`**: use modflow models as response functions.
- **`reservoirs`**: use reservoir models to simulate time series.
- **`responses`**: custom response functions for Pastas.

## Installation

<!-- TODO: add repo to PYPI so this becomes true: -->
Install `pastas-plugins` with:

```bash
pip install pastas_plugins
```

If you want to use a specific plugin and want to ensure you install all the requisite
dependencies, you can use the following command:

```bash
pip install pastas-plugins[<name of plugin>]
```

If you want to install them all:
```bash
pip install pastas-plugins[all]
```

## Usage

Import the pastas-plugins module with:

```python
import pastas_plugins as pp
```

This gives you access to the following functions:

```python
pp.list_plugins()         # list of all plugins
pp.show_plugin_versions() # show plugin versions 
```

The function `pp.show_plugin_versions()` will indicate if any dependencies are missing
for a particular plugin. See the [Installation](#installation) section above for tips
on how to install dependencies for a particular plugin.

To use a particular plugin, you'll have to import it explicitly, e.g.:

```python
from pastas_plugins import responses

rfunc = responses.Theis()
```

Separate plugins are each stored in a separate submodule within the pastas-plugins
package. You do not need to install the dependencies for each plugin if you're only
interested in one particular plugin.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pastas-plugins",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "\"D.A. Brakenhoff\" <d.brakenhoff@artesia-water.nl>, \"M.A. Vonk\" <m.vonk@artesia-water.nl>, \"M. Bakker\" <markbak@gmail.com>",
    "keywords": "hydrology, groundwater, timeseries, analysis",
    "author": "Pastas Developers Team",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/e3/7a/115716938e08bd24ecc5942777ec125809af173d601acedb5c3aba6041d1/pastas_plugins-0.2.0.tar.gz",
    "platform": null,
    "description": "# pastas-plugins\n\nWelcome to the pastas-plugins repository, your one-stop-shop for customized\ncutting-edge additions to Pastas.\n\n\n## Current plugins\n\nThe following plugins are now available:\n\n- **`cross_correlation`**: analyze and visualize the cross-correlation between two time series.\n- **`modflow`**: use modflow models as response functions.\n- **`reservoirs`**: use reservoir models to simulate time series.\n- **`responses`**: custom response functions for Pastas.\n\n## Installation\n\n<!-- TODO: add repo to PYPI so this becomes true: -->\nInstall `pastas-plugins` with:\n\n```bash\npip install pastas_plugins\n```\n\nIf you want to use a specific plugin and want to ensure you install all the requisite\ndependencies, you can use the following command:\n\n```bash\npip install pastas-plugins[<name of plugin>]\n```\n\nIf you want to install them all:\n```bash\npip install pastas-plugins[all]\n```\n\n## Usage\n\nImport the pastas-plugins module with:\n\n```python\nimport pastas_plugins as pp\n```\n\nThis gives you access to the following functions:\n\n```python\npp.list_plugins()         # list of all plugins\npp.show_plugin_versions() # show plugin versions \n```\n\nThe function `pp.show_plugin_versions()` will indicate if any dependencies are missing\nfor a particular plugin. See the [Installation](#installation) section above for tips\non how to install dependencies for a particular plugin.\n\nTo use a particular plugin, you'll have to import it explicitly, e.g.:\n\n```python\nfrom pastas_plugins import responses\n\nrfunc = responses.Theis()\n```\n\nSeparate plugins are each stored in a separate submodule within the pastas-plugins\npackage. You do not need to install the dependencies for each plugin if you're only\ninterested in one particular plugin.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Pastas  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": "Repository containing plugins to further enhance your pastas experience.",
    "version": "0.2.0",
    "project_urls": {
        "documentation": "https://pastas.readthedocs.io",
        "homepage": "https://pastas.dev",
        "repository": "https://github.com/pastas/pastas-plugins"
    },
    "split_keywords": [
        "hydrology",
        " groundwater",
        " timeseries",
        " analysis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "82f965c7a1718183f1128e458886a1d247befba6cc0a6cbfa85a822d5907b71d",
                "md5": "0618fbdae3159084601662e2202c3cd1",
                "sha256": "613d84bf4d15297b29e0c04f04d9099c72703d1e433d757d35677f47534a5856"
            },
            "downloads": -1,
            "filename": "pastas_plugins-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0618fbdae3159084601662e2202c3cd1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 20823,
            "upload_time": "2024-08-16T12:23:03",
            "upload_time_iso_8601": "2024-08-16T12:23:03.326452Z",
            "url": "https://files.pythonhosted.org/packages/82/f9/65c7a1718183f1128e458886a1d247befba6cc0a6cbfa85a822d5907b71d/pastas_plugins-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e37a115716938e08bd24ecc5942777ec125809af173d601acedb5c3aba6041d1",
                "md5": "3471a2455f49979e491c73ee9a95d91d",
                "sha256": "d87e47af9d3caea4aaf286f0f9244c52342a0cbc233b7e5d139df7624d161c1f"
            },
            "downloads": -1,
            "filename": "pastas_plugins-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3471a2455f49979e491c73ee9a95d91d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 19974,
            "upload_time": "2024-08-16T12:23:04",
            "upload_time_iso_8601": "2024-08-16T12:23:04.647716Z",
            "url": "https://files.pythonhosted.org/packages/e3/7a/115716938e08bd24ecc5942777ec125809af173d601acedb5c3aba6041d1/pastas_plugins-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-16 12:23:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pastas",
    "github_project": "pastas-plugins",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pastas-plugins"
}
Pastas Developers Team
Elapsed time: 0.27858s