HydPy


NameHydPy JSON
Version 5.0.3 PyPI version JSON
download
home_pagehttps://github.com/hydpy-dev/hydpy
SummaryA framework for the development and application of hydrological models.
upload_time2023-09-14 10:04:41
maintainer
docs_urlNone
authorHydPy Developers
requires_python>=3.8
licenseLGPL-3.0
keywords hydrology modelling water balance rainfall runoff
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            .. _`online documentation`: https://hydpy-dev.github.io/hydpy/
.. _Python: http://www.python.org/
.. _Cython: http://www.cython.org/
.. _`Ruhr-University Bochum`: http://www.hydrology.ruhr-uni-bochum.de/index.html.en
.. _`German Federal Institute of Hydrology`: https://www.bafg.de/EN
.. _`Björnsen Consulting Engineers`: https://www.bjoernsen.de/en/bjoernsen-consulting-engineers
.. _`GitHub repository`: https://github.com/hydpy-dev/hydpy
.. _`GNU Lesser General Public License 3`: https://www.gnu.org/licenses/lgpl-3.0.en.html
.. _`documentation test`: https://docs.python.org/3.6/library/doctest.html

.. figure:: hydpy/docs/figs/HydPy_Logo_Text.png
   :alt: HydPy logo


.. image:: https://img.shields.io/pypi/v/HydPy
   :alt: PyPI
   :target: https://pypi.org/project/HydPy
.. image:: https://img.shields.io/pypi/v/HydPy?label=download
   :alt: Releases
   :target: https://github.com/hydpy-dev/hydpy/releases
.. image:: https://img.shields.io/badge/docs-latest-informational
   :alt: Documentation
   :target: https://hydpy-dev.github.io/hydpy/index.html
.. image:: https://img.shields.io/github/license/hydpy-dev/hydpy?color=blue
   :alt: GitHub
   :target: https://github.com/hydpy-dev/hydpy/blob/master/LICENSE

\

.. image:: https://img.shields.io/badge/Coverage-100%20%25-green
   :alt: Coverage
   :target: https://coverage.readthedocs.io
.. image:: https://img.shields.io/badge/Black-All%20done%21-green
   :alt: Black
   :target: https://github.com/psf/black
.. image:: https://img.shields.io/badge/Pylint-10.00/10-green
   :alt: Pylint
   :target: https://www.pylint.org/
.. image:: https://img.shields.io/badge/Mypy-work%20in%20progress-orange
   :alt: Mypy
   :target: https://mypy.readthedocs.io/en/stable

\

.. image:: https://img.shields.io/travis/com/hydpy-dev/hydpy/master?label=Travis%20master
   :alt: Travis master
   :target: https://app.travis-ci.com/github/hydpy-dev/hydpy/branches
.. image:: https://img.shields.io/travis/com/hydpy-dev/hydpy?label=latest
   :alt: Travis latest
   :target: https://app.travis-ci.com/hydpy-dev/hydpy

\

.. image:: https://img.shields.io/appveyor/build/tyralla/hydpy-hep1s/master?label=AppVeyor%20master
   :alt: AppVeyor master
   :target: https://ci.appveyor.com/project/tyralla/hydpy-hep1s/history
.. image:: https://img.shields.io/appveyor/build/tyralla/hydpy-hep1s?label=latest
   :alt: AppVeyor latest
   :target: https://ci.appveyor.com/project/tyralla/hydpy-hep1s

\

.. image:: https://img.shields.io/github/issues-raw/hydpy-dev/hydpy
   :alt: GitHub issues
   :target: https://github.com/hydpy-dev/hydpy/issues?q=is%3Aopen+is%3Aissue
.. image:: https://img.shields.io/github/issues-closed-raw/hydpy-dev/hydpy?label=closed
   :alt: GitHub closed issues
   :target: https://github.com/hydpy-dev/hydpy/issues?q=is%3Aissue+is%3Aclosed

*HydPy* is an interactive framework for developing and applying
different types of hydrological models, originally developed
at the `Ruhr-University Bochum`_ for specific research purposes.
Later it was extended on behalf of the `German Federal Institute of
Hydrology`_ in order to be applicable in practical applications like
runoff forecasting in large river basins.  Now it is being maintained
by `Björnsen Consulting Engineers`_.


*HydPy* is intended to be a modern open source software, based on the
programming language `Python`_, commonly used in many scientific fields.
Through using different well-established `Python`_ libraries and design
principles, we target high quality and transparency standards. To avoid
writing model cores in a more native programming language, *HydPy*
includes a `Cython`_ based mechanism to automatically translate
Python code to C code and to compile it.

*HydPy* has no graphical user interface (so far). Instead, it is thought
to be applied by executing Python scripts. These scripts help to increase
the reproducibility of studies performed with *HydPy* because
they can be easily shared and repeatedly executed.  This approach facilitates
discussing possible weaknesses of *HydPy* and its implemented
models and comparing different methodical approaches (e. g. different
strategies to calibrate model parameters).  However, if you are not an
experienced hydrologist with basic programming skills, you may need
some help to become acquainted with *HydPy*.

We host *HydPy* in a `GitHub repository`_ and everyone
is allowed to download, modify, and use it.  However, when passing the
(possibly modified) code to third parties, you have to be aware you
cannot change the selected `GNU Lesser General Public License 3`_
to a "less open source" license.  If you, for example, implement a model
into *HydPy*, you can be sure that all possible further developments of
your model code are still open source and the mentioned third parties
are allowed to pass this modified source code to you.

*HydPy* offers many functionalities to make the implemented
models as transparent and reliable as possible.  For this reason,
the `online documentation`_ is automatically updated for each new
*HydPy* version and includes different `documentation test`_ mechanisms
ensuring that *HydPy* is working as expected and that the complete
documentation is up-to-date with it.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/hydpy-dev/hydpy",
    "name": "HydPy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "hydrology modelling water balance rainfall runoff",
    "author": "HydPy Developers",
    "author_email": "c.tyralla@bjoernsen.de",
    "download_url": "https://files.pythonhosted.org/packages/ac/45/2a261e468079fc6849ec1737f917988dd3a625df0f6cf1314af367692e06/HydPy-5.0.3.tar.gz",
    "platform": null,
    "description": ".. _`online documentation`: https://hydpy-dev.github.io/hydpy/\r\n.. _Python: http://www.python.org/\r\n.. _Cython: http://www.cython.org/\r\n.. _`Ruhr-University Bochum`: http://www.hydrology.ruhr-uni-bochum.de/index.html.en\r\n.. _`German Federal Institute of Hydrology`: https://www.bafg.de/EN\r\n.. _`Bj\u00f6rnsen Consulting Engineers`: https://www.bjoernsen.de/en/bjoernsen-consulting-engineers\r\n.. _`GitHub repository`: https://github.com/hydpy-dev/hydpy\r\n.. _`GNU Lesser General Public License 3`: https://www.gnu.org/licenses/lgpl-3.0.en.html\r\n.. _`documentation test`: https://docs.python.org/3.6/library/doctest.html\r\n\r\n.. figure:: hydpy/docs/figs/HydPy_Logo_Text.png\r\n   :alt: HydPy logo\r\n\r\n\r\n.. image:: https://img.shields.io/pypi/v/HydPy\r\n   :alt: PyPI\r\n   :target: https://pypi.org/project/HydPy\r\n.. image:: https://img.shields.io/pypi/v/HydPy?label=download\r\n   :alt: Releases\r\n   :target: https://github.com/hydpy-dev/hydpy/releases\r\n.. image:: https://img.shields.io/badge/docs-latest-informational\r\n   :alt: Documentation\r\n   :target: https://hydpy-dev.github.io/hydpy/index.html\r\n.. image:: https://img.shields.io/github/license/hydpy-dev/hydpy?color=blue\r\n   :alt: GitHub\r\n   :target: https://github.com/hydpy-dev/hydpy/blob/master/LICENSE\r\n\r\n\\\r\n\r\n.. image:: https://img.shields.io/badge/Coverage-100%20%25-green\r\n   :alt: Coverage\r\n   :target: https://coverage.readthedocs.io\r\n.. image:: https://img.shields.io/badge/Black-All%20done%21-green\r\n   :alt: Black\r\n   :target: https://github.com/psf/black\r\n.. image:: https://img.shields.io/badge/Pylint-10.00/10-green\r\n   :alt: Pylint\r\n   :target: https://www.pylint.org/\r\n.. image:: https://img.shields.io/badge/Mypy-work%20in%20progress-orange\r\n   :alt: Mypy\r\n   :target: https://mypy.readthedocs.io/en/stable\r\n\r\n\\\r\n\r\n.. image:: https://img.shields.io/travis/com/hydpy-dev/hydpy/master?label=Travis%20master\r\n   :alt: Travis master\r\n   :target: https://app.travis-ci.com/github/hydpy-dev/hydpy/branches\r\n.. image:: https://img.shields.io/travis/com/hydpy-dev/hydpy?label=latest\r\n   :alt: Travis latest\r\n   :target: https://app.travis-ci.com/hydpy-dev/hydpy\r\n\r\n\\\r\n\r\n.. image:: https://img.shields.io/appveyor/build/tyralla/hydpy-hep1s/master?label=AppVeyor%20master\r\n   :alt: AppVeyor master\r\n   :target: https://ci.appveyor.com/project/tyralla/hydpy-hep1s/history\r\n.. image:: https://img.shields.io/appveyor/build/tyralla/hydpy-hep1s?label=latest\r\n   :alt: AppVeyor latest\r\n   :target: https://ci.appveyor.com/project/tyralla/hydpy-hep1s\r\n\r\n\\\r\n\r\n.. image:: https://img.shields.io/github/issues-raw/hydpy-dev/hydpy\r\n   :alt: GitHub issues\r\n   :target: https://github.com/hydpy-dev/hydpy/issues?q=is%3Aopen+is%3Aissue\r\n.. image:: https://img.shields.io/github/issues-closed-raw/hydpy-dev/hydpy?label=closed\r\n   :alt: GitHub closed issues\r\n   :target: https://github.com/hydpy-dev/hydpy/issues?q=is%3Aissue+is%3Aclosed\r\n\r\n*HydPy* is an interactive framework for developing and applying\r\ndifferent types of hydrological models, originally developed\r\nat the `Ruhr-University Bochum`_ for specific research purposes.\r\nLater it was extended on behalf of the `German Federal Institute of\r\nHydrology`_ in order to be applicable in practical applications like\r\nrunoff forecasting in large river basins.  Now it is being maintained\r\nby `Bj\u00f6rnsen Consulting Engineers`_.\r\n\r\n\r\n*HydPy* is intended to be a modern open source software, based on the\r\nprogramming language `Python`_, commonly used in many scientific fields.\r\nThrough using different well-established `Python`_ libraries and design\r\nprinciples, we target high quality and transparency standards. To avoid\r\nwriting model cores in a more native programming language, *HydPy*\r\nincludes a `Cython`_ based mechanism to automatically translate\r\nPython code to C code and to compile it.\r\n\r\n*HydPy* has no graphical user interface (so far). Instead, it is thought\r\nto be applied by executing Python scripts. These scripts help to increase\r\nthe reproducibility of studies performed with *HydPy* because\r\nthey can be easily shared and repeatedly executed.  This approach facilitates\r\ndiscussing possible weaknesses of *HydPy* and its implemented\r\nmodels and comparing different methodical approaches (e. g. different\r\nstrategies to calibrate model parameters).  However, if you are not an\r\nexperienced hydrologist with basic programming skills, you may need\r\nsome help to become acquainted with *HydPy*.\r\n\r\nWe host *HydPy* in a `GitHub repository`_ and everyone\r\nis allowed to download, modify, and use it.  However, when passing the\r\n(possibly modified) code to third parties, you have to be aware you\r\ncannot change the selected `GNU Lesser General Public License 3`_\r\nto a \"less open source\" license.  If you, for example, implement a model\r\ninto *HydPy*, you can be sure that all possible further developments of\r\nyour model code are still open source and the mentioned third parties\r\nare allowed to pass this modified source code to you.\r\n\r\n*HydPy* offers many functionalities to make the implemented\r\nmodels as transparent and reliable as possible.  For this reason,\r\nthe `online documentation`_ is automatically updated for each new\r\n*HydPy* version and includes different `documentation test`_ mechanisms\r\nensuring that *HydPy* is working as expected and that the complete\r\ndocumentation is up-to-date with it.\r\n",
    "bugtrack_url": null,
    "license": "LGPL-3.0",
    "summary": "A framework for the development and application of hydrological models.",
    "version": "5.0.3",
    "project_urls": {
        "Homepage": "https://github.com/hydpy-dev/hydpy"
    },
    "split_keywords": [
        "hydrology",
        "modelling",
        "water",
        "balance",
        "rainfall",
        "runoff"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "65d3d49d866c83383e343cf71599d0d255ccd6ce86d5c63b3fed21d5780c6046",
                "md5": "1a91097b5af482451b9ddc80053d8ede",
                "sha256": "078a82f5ac20aaa2286ebb097aa4d4d28fdc3b3d4c496b8a8c1c53b08e028e45"
            },
            "downloads": -1,
            "filename": "HydPy-5.0.3-cp38-cp38-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "1a91097b5af482451b9ddc80053d8ede",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": ">=3.8",
            "size": 15333148,
            "upload_time": "2023-09-14T10:04:38",
            "upload_time_iso_8601": "2023-09-14T10:04:38.642781Z",
            "url": "https://files.pythonhosted.org/packages/65/d3/d49d866c83383e343cf71599d0d255ccd6ce86d5c63b3fed21d5780c6046/HydPy-5.0.3-cp38-cp38-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ac452a261e468079fc6849ec1737f917988dd3a625df0f6cf1314af367692e06",
                "md5": "aba02f977c31b0661dc7d22909d0b1dc",
                "sha256": "7e177ceec6665a4889ff3e00ab14a170674f22d2a146d34ac291356be56ee31f"
            },
            "downloads": -1,
            "filename": "HydPy-5.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "aba02f977c31b0661dc7d22909d0b1dc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 4909609,
            "upload_time": "2023-09-14T10:04:41",
            "upload_time_iso_8601": "2023-09-14T10:04:41.074514Z",
            "url": "https://files.pythonhosted.org/packages/ac/45/2a261e468079fc6849ec1737f917988dd3a625df0f6cf1314af367692e06/HydPy-5.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-14 10:04:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hydpy-dev",
    "github_project": "hydpy",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "appveyor": true,
    "requirements": [],
    "lcname": "hydpy"
}
        
Elapsed time: 0.11542s