power-grid-model-io


Namepower-grid-model-io JSON
Version 1.2.80 PyPI version JSON
download
home_pageNone
SummaryPower Grid Model Input/Output
upload_time2024-04-22 06:34:31
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMPL-2.0
keywords power grid model input/output conversions
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <!--
SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>

SPDX-License-Identifier: MPL-2.0
-->

[![PyPI version](https://badge.fury.io/py/power-grid-model-io.svg?no-cache)](https://badge.fury.io/py/power-grid-model-io)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/power-grid-model-io/badges/version.svg?no-cache)](https://anaconda.org/conda-forge/power-grid-model-io)
[![License: MIT](https://img.shields.io/badge/License-MPL2.0-informational.svg)](https://github.com/PowerGridModel/power-grid-model-io/blob/main/LICENSE)
[![Build and Test Python](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/build-test-and-sonar.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/build-test-and-sonar.yml)
[![Check Code Quality](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/check-code-quality.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/check-code-quality.yml)
[![REUSE Compliance Check](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/reuse-compliance.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/reuse-compliance.yml)
[![docs](https://readthedocs.org/projects/power-grid-model-io/badge/)](https://power-grid-model-io.readthedocs.io/en/stable/)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=coverage)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8059257.svg)](https://zenodo.org/record/8059257)

[![](https://github.com/PowerGridModel/.github/blob/main/artwork/svg/color.svg)](#)

# Power Grid Model Input/Output

`power-grid-model-io` can be used for various conversions to the [power-grid-model](https://github.com/PowerGridModel/power-grid-model).
For detailed documentation, see [Read the Docs](https://power-grid-model-io.readthedocs.io/en/stable/index.html).

## Installation

### Install from PyPI

You can directly install the package from PyPI.

```
pip install power-grid-model-io
```

### Install from Conda

If you are using `conda`, you can directly install the package from `conda-forge` channel.

```
conda install -c conda-forge power-grid-model-io
```

## Examples

* [PGM JSON Example](https://github.com/PowerGridModel/power-grid-model-io/tree/main/docs/examples)

## License

This project is licensed under the Mozilla Public License, version 2.0 - see [LICENSE](https://github.com/PowerGridModel/power-grid-model-io/blob/main/LICENSE) for details.

## Contributing

Please read [CODE_OF_CONDUCT](https://github.com/PowerGridModel/.github/blob/main/CODE_OF_CONDUCT.md) and [CONTRIBUTING](https://github.com/PowerGridModel/.github/blob/main/CONTRIBUTING.md) for details on the process 
for submitting pull requests to us.

Visit [Contribute](https://github.com/PowerGridModel/power-grid-model-io/contribute) for a list of good first issues in this repo.

## Citations

If you are using Power Grid Model IO in your research work, please consider citing our library using the following references.

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8059257.svg)](https://zenodo.org/record/8059257)

```bibtex
@software{Xiang_PowerGridModel_power-grid-model-io,
  author = {Xiang, Yu and Salemink, Peter and Bharambe, Nitish and Govers, Martinus and van den Bogaard, Jonas and Stoeller, Bram and Wang, Zhen and Guo, Jerry and Jagutis, Laurynas and Wang, Chenguang and {Contributors to the LF Energy project Power Grid Model}},
  doi = {10.5281/zenodo.8059257},
  license = {MPL-2.0},
  title = {{PowerGridModel/power-grid-model-io}},
  url = {https://github.com/PowerGridModel/power-grid-model-io}
}
@software{Xiang_PowerGridModel_power-grid-model,
  author = {Xiang, Yu and Salemink, Peter and Bharambe, Nitish and Govers, Martinus and van den Bogaard, Jonas and Stoeller, Bram and Wang, Zhen and Guo, Jerry and Jagutis, Laurynas and Wang, Chenguang and van Raalte, Marc and {Contributors to the LF Energy project Power Grid Model}},
  doi = {10.5281/zenodo.8054429},
  license = {MPL-2.0},
  title = {{PowerGridModel/power-grid-model}},
  url = {https://github.com/PowerGridModel/power-grid-model}
}
@inproceedings{Xiang2023,
  author = {Xiang, Yu and Salemink, Peter and Stoeller, Bram and Bharambe, Nitish and van Westering, Werner},
  booktitle = {CIRED 2023 - The 27th International Conference and Exhibition on Electricity Distribution},
  title = {Power grid model: A high-performance distribution grid calculation library},
  year = {2023},
  volume={2023},
  number = {},
  pages={1-5}
}
```

## Contact

Please read [SUPPORT](https://github.com/PowerGridModel/.github/blob/main/SUPPORT.md) for how to connect and get into contact with the Power Gird Model IO project.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "power-grid-model-io",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "power grid model, input/output, conversions",
    "author": null,
    "author_email": "Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>",
    "download_url": "https://files.pythonhosted.org/packages/a2/71/9e39eb21cc14dcf75eb529c53b52d5a7fa6ef2fbaaafb675c64cadd64322/power_grid_model_io-1.2.80.tar.gz",
    "platform": null,
    "description": "<!--\nSPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>\n\nSPDX-License-Identifier: MPL-2.0\n-->\n\n[![PyPI version](https://badge.fury.io/py/power-grid-model-io.svg?no-cache)](https://badge.fury.io/py/power-grid-model-io)\n[![Anaconda-Server Badge](https://anaconda.org/conda-forge/power-grid-model-io/badges/version.svg?no-cache)](https://anaconda.org/conda-forge/power-grid-model-io)\n[![License: MIT](https://img.shields.io/badge/License-MPL2.0-informational.svg)](https://github.com/PowerGridModel/power-grid-model-io/blob/main/LICENSE)\n[![Build and Test Python](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/build-test-and-sonar.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/build-test-and-sonar.yml)\n[![Check Code Quality](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/check-code-quality.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/check-code-quality.yml)\n[![REUSE Compliance Check](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/reuse-compliance.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/reuse-compliance.yml)\n[![docs](https://readthedocs.org/projects/power-grid-model-io/badge/)](https://power-grid-model-io.readthedocs.io/en/stable/)\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=coverage)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)\n\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8059257.svg)](https://zenodo.org/record/8059257)\n\n[![](https://github.com/PowerGridModel/.github/blob/main/artwork/svg/color.svg)](#)\n\n# Power Grid Model Input/Output\n\n`power-grid-model-io` can be used for various conversions to the [power-grid-model](https://github.com/PowerGridModel/power-grid-model).\nFor detailed documentation, see [Read the Docs](https://power-grid-model-io.readthedocs.io/en/stable/index.html).\n\n## Installation\n\n### Install from PyPI\n\nYou can directly install the package from PyPI.\n\n```\npip install power-grid-model-io\n```\n\n### Install from Conda\n\nIf you are using `conda`, you can directly install the package from `conda-forge` channel.\n\n```\nconda install -c conda-forge power-grid-model-io\n```\n\n## Examples\n\n* [PGM JSON Example](https://github.com/PowerGridModel/power-grid-model-io/tree/main/docs/examples)\n\n## License\n\nThis project is licensed under the Mozilla Public License, version 2.0 - see [LICENSE](https://github.com/PowerGridModel/power-grid-model-io/blob/main/LICENSE) for details.\n\n## Contributing\n\nPlease read [CODE_OF_CONDUCT](https://github.com/PowerGridModel/.github/blob/main/CODE_OF_CONDUCT.md) and [CONTRIBUTING](https://github.com/PowerGridModel/.github/blob/main/CONTRIBUTING.md) for details on the process \nfor submitting pull requests to us.\n\nVisit [Contribute](https://github.com/PowerGridModel/power-grid-model-io/contribute) for a list of good first issues in this repo.\n\n## Citations\n\nIf you are using Power Grid Model IO in your research work, please consider citing our library using the following references.\n\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8059257.svg)](https://zenodo.org/record/8059257)\n\n```bibtex\n@software{Xiang_PowerGridModel_power-grid-model-io,\n  author = {Xiang, Yu and Salemink, Peter and Bharambe, Nitish and Govers, Martinus and van den Bogaard, Jonas and Stoeller, Bram and Wang, Zhen and Guo, Jerry and Jagutis, Laurynas and Wang, Chenguang and {Contributors to the LF Energy project Power Grid Model}},\n  doi = {10.5281/zenodo.8059257},\n  license = {MPL-2.0},\n  title = {{PowerGridModel/power-grid-model-io}},\n  url = {https://github.com/PowerGridModel/power-grid-model-io}\n}\n@software{Xiang_PowerGridModel_power-grid-model,\n  author = {Xiang, Yu and Salemink, Peter and Bharambe, Nitish and Govers, Martinus and van den Bogaard, Jonas and Stoeller, Bram and Wang, Zhen and Guo, Jerry and Jagutis, Laurynas and Wang, Chenguang and van Raalte, Marc and {Contributors to the LF Energy project Power Grid Model}},\n  doi = {10.5281/zenodo.8054429},\n  license = {MPL-2.0},\n  title = {{PowerGridModel/power-grid-model}},\n  url = {https://github.com/PowerGridModel/power-grid-model}\n}\n@inproceedings{Xiang2023,\n  author = {Xiang, Yu and Salemink, Peter and Stoeller, Bram and Bharambe, Nitish and van Westering, Werner},\n  booktitle = {CIRED 2023 - The 27th International Conference and Exhibition on Electricity Distribution},\n  title = {Power grid model: A high-performance distribution grid calculation library},\n  year = {2023},\n  volume={2023},\n  number = {},\n  pages={1-5}\n}\n```\n\n## Contact\n\nPlease read [SUPPORT](https://github.com/PowerGridModel/.github/blob/main/SUPPORT.md) for how to connect and get into contact with the Power Gird Model IO project.\n",
    "bugtrack_url": null,
    "license": "MPL-2.0",
    "summary": "Power Grid Model Input/Output",
    "version": "1.2.80",
    "project_urls": {
        "Discussion": "https://github.com/orgs/PowerGridModel/discussions",
        "Documentation": "https://power-grid-model-io.readthedocs.io/en/stable/",
        "GitHub": "https://github.com/PowerGridModel/power-grid-model-io",
        "Home-page": "https://lfenergy.org/projects/power-grid-model/",
        "Mailing-list": "https://lists.lfenergy.org/g/powergridmodel"
    },
    "split_keywords": [
        "power grid model",
        " input/output",
        " conversions"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1ac6610126ca91fd48544dbde6d07da665a0f2e7010bcac1fdcdffc67a67f4b0",
                "md5": "113f737d6b2a5e91ce210c12fb4636b1",
                "sha256": "285ba9ebbef3f7426e7b2fd75e55841b609e5dc6adfea0da9e0e9f94d952d05d"
            },
            "downloads": -1,
            "filename": "power_grid_model_io-1.2.80-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "113f737d6b2a5e91ce210c12fb4636b1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 80946,
            "upload_time": "2024-04-22T06:34:26",
            "upload_time_iso_8601": "2024-04-22T06:34:26.755464Z",
            "url": "https://files.pythonhosted.org/packages/1a/c6/610126ca91fd48544dbde6d07da665a0f2e7010bcac1fdcdffc67a67f4b0/power_grid_model_io-1.2.80-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a2719e39eb21cc14dcf75eb529c53b52d5a7fa6ef2fbaaafb675c64cadd64322",
                "md5": "188d8bafaac76474e0c0cd3bd5d8b32e",
                "sha256": "6e9d9a9dc47ccba19f93f10c8e9c9eaa4b6c6789588ea01888376c13b003d5c2"
            },
            "downloads": -1,
            "filename": "power_grid_model_io-1.2.80.tar.gz",
            "has_sig": false,
            "md5_digest": "188d8bafaac76474e0c0cd3bd5d8b32e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 224227,
            "upload_time": "2024-04-22T06:34:31",
            "upload_time_iso_8601": "2024-04-22T06:34:31.129671Z",
            "url": "https://files.pythonhosted.org/packages/a2/71/9e39eb21cc14dcf75eb529c53b52d5a7fa6ef2fbaaafb675c64cadd64322/power_grid_model_io-1.2.80.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-22 06:34:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "orgs",
    "github_project": "PowerGridModel",
    "github_not_found": true,
    "lcname": "power-grid-model-io"
}
None
Elapsed time: 0.25047s