pandahub


Namepandahub JSON
Version 0.3.11 PyPI version JSON
download
home_pageNone
SummaryData hub for pandapower and pandapipes networks based on MongoDB
upload_time2024-11-19 07:38:24
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseCopyright (c) 2022 by University of Kassel, Fraunhofer Institute for Energy Economics and Energy System Technology (IEE) Kassel, retoflow GmbH individual contributors (see AUTHORS file for details). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords network analysis optimization automation grid energy engineering simulation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![pandapower](https://www.pandapower.org/images/pp.svg)](https://www.pandapower.org)         [![pandapipes](https://www.pandapipes.org/images/pp.svg)](https://www.pandapipes.org)

[![pandahub](https://badge.fury.io/py/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/pypi/pyversions/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/e2nIEE/pandahub/blob/master/LICENSE)

pandahub is a data hub for pandapower and pandapipes networks based on MongoDB. It allows you to store pandapower and
pandapipes networks as well as timeseries in a MongoDB. pandahub allows you to access the database directly through the PandaHub class,
but also provides a REST-API based on FastAPI. Access through the API is managed with a user management implementation based on FastAPI Users.

## Development
`docker compose up -d` runs a mongodb container alongside a pandahub api instance with live reload available
at http://localhost:8002. To connect to an existing database instead, set `MONGODB_URL` to the connection string through an environment variable / in you `.env` file.

Swagger UI is available at http://localhost:8002/docs.

If you develop on the library and do not need the fastapi app, `docker compose up db -d` starts only the mongodb
container.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pandahub",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "network, analysis, optimization, automation, grid, energy, engineering, simulation",
    "author": null,
    "author_email": "Jan Ulffers <jan.ulffers@iee.fraunhofer.de>, Leon Thurner <leon.thurner@retoflow.de>, Jannis Kupka <jannis.kupka@retoflow.de>, Mike Vogt <mike.vogt@iee.fraunhofer.de>, Joschka Thurner <joschka.thurner@retoflow.de>, Alexander Scheidler <alexander.scheidler@iee.fraunhofer.de>",
    "download_url": "https://files.pythonhosted.org/packages/f3/3f/5194e8bf676e2f542f587a60b181daba8dcdf411ade6af56d4f6ed619654/pandahub-0.3.11.zip",
    "platform": null,
    "description": "[![pandapower](https://www.pandapower.org/images/pp.svg)](https://www.pandapower.org)         [![pandapipes](https://www.pandapipes.org/images/pp.svg)](https://www.pandapipes.org)\n\n[![pandahub](https://badge.fury.io/py/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/pypi/pyversions/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/e2nIEE/pandahub/blob/master/LICENSE)\n\npandahub is a data hub for pandapower and pandapipes networks based on MongoDB. It allows you to store pandapower and\npandapipes networks as well as timeseries in a MongoDB. pandahub allows you to access the database directly through the PandaHub class,\nbut also provides a REST-API based on FastAPI. Access through the API is managed with a user management implementation based on FastAPI Users.\n\n## Development\n`docker compose up -d` runs a mongodb container alongside a pandahub api instance with live reload available\nat http://localhost:8002. To connect to an existing database instead, set `MONGODB_URL` to the connection string through an environment variable / in you `.env` file.\n\nSwagger UI is available at http://localhost:8002/docs.\n\nIf you develop on the library and do not need the fastapi app, `docker compose up db -d` starts only the mongodb\ncontainer.\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2022 by University of Kassel, Fraunhofer Institute for Energy Economics and Energy System Technology (IEE) Kassel, retoflow GmbH individual contributors (see AUTHORS file for details). All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "Data hub for pandapower and pandapipes networks based on MongoDB",
    "version": "0.3.11",
    "project_urls": {
        "Changelog": "https://github.com/e2nIEE/pandahub/blob/develop/CHANGELOG.md",
        "Documentation": "https://pandapipes.readthedocs.io",
        "Download": "https://pypi.org/project/pandahub/#files",
        "Homepage": "https://github.com/e2nIEE/pandahub",
        "Issues": "https://github.com/e2nIEE/pandahub/issues",
        "Repository": "https://github.com/e2nIEE/pandahub.git",
        "Source": "https://github.com/e2nIEE/pandahub"
    },
    "split_keywords": [
        "network",
        " analysis",
        " optimization",
        " automation",
        " grid",
        " energy",
        " engineering",
        " simulation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f33f5194e8bf676e2f542f587a60b181daba8dcdf411ade6af56d4f6ed619654",
                "md5": "712412de08d15c86f8854399a439950e",
                "sha256": "63293347be411db7c6ec0ed41caf81166181888f220a48fe5fa8b2141e85ab24"
            },
            "downloads": -1,
            "filename": "pandahub-0.3.11.zip",
            "has_sig": false,
            "md5_digest": "712412de08d15c86f8854399a439950e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 62730,
            "upload_time": "2024-11-19T07:38:24",
            "upload_time_iso_8601": "2024-11-19T07:38:24.903317Z",
            "url": "https://files.pythonhosted.org/packages/f3/3f/5194e8bf676e2f542f587a60b181daba8dcdf411ade6af56d4f6ed619654/pandahub-0.3.11.zip",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-19 07:38:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "e2nIEE",
    "github_project": "pandahub",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "pandahub"
}
        
Elapsed time: 0.36851s