GasNetSim


NameGasNetSim JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummaryA tool for gas network steady-state simulation.
upload_time2024-09-17 15:02:28
maintainerYifei Lu
docs_urlNone
authorICE-1: Energy Systems Engineering, Forschungszentrum Jülich GmbH
requires_python<4.0,>=3.9
licenseMPL-2.0
keywords gas network simulation energy systems
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![](https://jugit.fz-juelich.de/iek-10/public/simulation/gasnetsim/-/raw/main/docs/GasNetSim_Logo.svg)

[//]: # ([![PyPI]&#40;https://badge.fury.io/py/GasNetSim.svg&#41;]&#40;https://badge.fury.io/py/GasNetSim&#41;)
[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-370/)
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Fjugit.fz-juelich.de%2Fiek-10%2Fpublic%2Fsimulation%2Fgasnetsim/HEAD)
[![DOI:10.1109/OSMSES54027.2022.9769148](https://zenodo.org/badge/DOI/10.1109/OSMSES54027.2022.9769148.svg)](https://doi.org/10.1109/OSMSES54027.2022.9769148)

# **GasNetSim**

*GasNetSim* is a simulation package designed for gas network steady-state simulation. 
It supports the steady-state natural gas network simulations with different gas mixture
compositions, thus enabling accurate analysis of the impacts of hydrogen injection on the gas network.  
Moreover, users have the flexibility to modify this tool and implement their own desired
gas mixture modeling approaches.
Future work will be carried out to include gas storage units and to take into account 
the dynamic behavior of the gas network so that short-term simulations can be performed.

## Installation
Currently, it is only supported using source files. Using following commands to install the package in editable mode.

  - ``pip install -e .``
  - ``pip install -r ./requirements.txt``

## License

The project is released under the terms of the [MPL 2.0](https://mozilla.org/MPL/2.0/).

## Dependencies
<!-- Dependencies -->
- ``numpy``>=1.19.2
- ``matplotlib``>=3.3.2
- ``scipy``>=1.5.2
- ``pandas``>=1.1.3
- ``pytest``>=6.2.5
- ``fluids``>=0.1.86
- ``pint``>=0.18
- ``setuptools``>=60.9.3
- ``requests``>=2.25.1
- ``pyparsing``~=3.0.7
- ``cantera``~=3.0.0
- ``thermo``~=0.2.23
- ``tqdm``>=4.64.1
- ``seaborn``>=0.12.2
- ``networkx``~=3.1
<!-- End Dependencies -->

For the ``thermo`` package, the version used in this repo is 0.1.40. Because there are some changes 
and new features included in the newer versions. The source files of the `thermo` package is directly
stored in this repo. It will be updated in the future.

[//]: # (## Discussion)

[//]: # ()
[//]: # (You can connect with the community in a variety of ways...)

[//]: # ()
[//]: # (- [Mailing list]&#40;https://lists.lfenergy.org/g/xxxx-discussion&#41;)

[//]: # (- [#{{**PROJECT-NAME**}} channel on LF Energy Slack]&#40;https://slack.lfenergy.org&#41;)

[//]: # (- Other communication channels, e.g. Discord, Slack, Skype, Mattermost, FZJ Rocket Chat, ...)

[//]: # (## Contributing)

[//]: # ()
[//]: # (_**TODO** Provide contributing guidelines here or point to a_)

[//]: # (_[CONTRIBUTING.md]&#40;CONTRIBUTING.md&#41; file if the contributing guidelines require_)

[//]: # (_more than just a few lines._)

## Reporting Issues

To report a problem, you can open an 
[issue](https://jugit.fz-juelich.de/iek-10/public/simulation/gasnetsim/-/issues)
in repository against a specific workflow. If the issue is sensitive in nature or
a security related issue, please do not report in the issue tracker but instead
email [Yifei Lu](yi.lu@fz-juelich.de).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "GasNetSim",
    "maintainer": "Yifei Lu",
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": "yifei.lu@fz-juelich.de",
    "keywords": "gas network, simulation, energy systems",
    "author": "ICE-1: Energy Systems Engineering, Forschungszentrum J\u00fclich GmbH",
    "author_email": "yifei.lu@fz-juelich.de",
    "download_url": "https://files.pythonhosted.org/packages/2c/4f/ddbbf59e6c61091418a2b0f0cf33bc7f225003fb42b8b37c04736ccb260b/gasnetsim-0.1.1.tar.gz",
    "platform": null,
    "description": "![](https://jugit.fz-juelich.de/iek-10/public/simulation/gasnetsim/-/raw/main/docs/GasNetSim_Logo.svg)\n\n[//]: # ([![PyPI]&#40;https://badge.fury.io/py/GasNetSim.svg&#41;]&#40;https://badge.fury.io/py/GasNetSim&#41;)\n[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-370/)\n[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Fjugit.fz-juelich.de%2Fiek-10%2Fpublic%2Fsimulation%2Fgasnetsim/HEAD)\n[![DOI:10.1109/OSMSES54027.2022.9769148](https://zenodo.org/badge/DOI/10.1109/OSMSES54027.2022.9769148.svg)](https://doi.org/10.1109/OSMSES54027.2022.9769148)\n\n# **GasNetSim**\n\n*GasNetSim* is a simulation package designed for gas network steady-state simulation. \nIt supports the steady-state natural gas network simulations with different gas mixture\ncompositions, thus enabling accurate analysis of the impacts of hydrogen injection on the gas network.  \nMoreover, users have the flexibility to modify this tool and implement their own desired\ngas mixture modeling approaches.\nFuture work will be carried out to include gas storage units and to take into account \nthe dynamic behavior of the gas network so that short-term simulations can be performed.\n\n## Installation\nCurrently, it is only supported using source files. Using following commands to install the package in editable mode.\n\n  - ``pip install -e .``\n  - ``pip install -r ./requirements.txt``\n\n## License\n\nThe project is released under the terms of the [MPL 2.0](https://mozilla.org/MPL/2.0/).\n\n## Dependencies\n<!-- Dependencies -->\n- ``numpy``>=1.19.2\n- ``matplotlib``>=3.3.2\n- ``scipy``>=1.5.2\n- ``pandas``>=1.1.3\n- ``pytest``>=6.2.5\n- ``fluids``>=0.1.86\n- ``pint``>=0.18\n- ``setuptools``>=60.9.3\n- ``requests``>=2.25.1\n- ``pyparsing``~=3.0.7\n- ``cantera``~=3.0.0\n- ``thermo``~=0.2.23\n- ``tqdm``>=4.64.1\n- ``seaborn``>=0.12.2\n- ``networkx``~=3.1\n<!-- End Dependencies -->\n\nFor the ``thermo`` package, the version used in this repo is 0.1.40. Because there are some changes \nand new features included in the newer versions. The source files of the `thermo` package is directly\nstored in this repo. It will be updated in the future.\n\n[//]: # (## Discussion)\n\n[//]: # ()\n[//]: # (You can connect with the community in a variety of ways...)\n\n[//]: # ()\n[//]: # (- [Mailing list]&#40;https://lists.lfenergy.org/g/xxxx-discussion&#41;)\n\n[//]: # (- [#{{**PROJECT-NAME**}} channel on LF Energy Slack]&#40;https://slack.lfenergy.org&#41;)\n\n[//]: # (- Other communication channels, e.g. Discord, Slack, Skype, Mattermost, FZJ Rocket Chat, ...)\n\n[//]: # (## Contributing)\n\n[//]: # ()\n[//]: # (_**TODO** Provide contributing guidelines here or point to a_)\n\n[//]: # (_[CONTRIBUTING.md]&#40;CONTRIBUTING.md&#41; file if the contributing guidelines require_)\n\n[//]: # (_more than just a few lines._)\n\n## Reporting Issues\n\nTo report a problem, you can open an \n[issue](https://jugit.fz-juelich.de/iek-10/public/simulation/gasnetsim/-/issues)\nin repository against a specific workflow. If the issue is sensitive in nature or\na security related issue, please do not report in the issue tracker but instead\nemail [Yifei Lu](yi.lu@fz-juelich.de).\n",
    "bugtrack_url": null,
    "license": "MPL-2.0",
    "summary": "A tool for gas network steady-state simulation.",
    "version": "0.1.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/python-poetry/poetry/issues",
        "homepage": "https://jugit.fz-juelich.de/iek-10/public/simulation/gasnetsim"
    },
    "split_keywords": [
        "gas network",
        " simulation",
        " energy systems"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c97545d2d7b1bdfe047373e6f7faea6966ea502608ed435df3b17bb6b0547483",
                "md5": "25b64f7c54e8b56e3617235a1ef8f83e",
                "sha256": "4a871360dd55f645d27332fe1a1c104894959b8f8a7581754f7cfdb3ea41c442"
            },
            "downloads": -1,
            "filename": "gasnetsim-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "25b64f7c54e8b56e3617235a1ef8f83e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 366960,
            "upload_time": "2024-09-17T15:02:24",
            "upload_time_iso_8601": "2024-09-17T15:02:24.924910Z",
            "url": "https://files.pythonhosted.org/packages/c9/75/45d2d7b1bdfe047373e6f7faea6966ea502608ed435df3b17bb6b0547483/gasnetsim-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2c4fddbbf59e6c61091418a2b0f0cf33bc7f225003fb42b8b37c04736ccb260b",
                "md5": "d72998a9472d3cebe282d758f350529f",
                "sha256": "29ec925b472bd82e920a157a4221c3859bee63e76f1373cf62ed6158c617244a"
            },
            "downloads": -1,
            "filename": "gasnetsim-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d72998a9472d3cebe282d758f350529f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 417994,
            "upload_time": "2024-09-17T15:02:28",
            "upload_time_iso_8601": "2024-09-17T15:02:28.925028Z",
            "url": "https://files.pythonhosted.org/packages/2c/4f/ddbbf59e6c61091418a2b0f0cf33bc7f225003fb42b8b37c04736ccb260b/gasnetsim-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-17 15:02:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "python-poetry",
    "github_project": "poetry",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gasnetsim"
}
        
Elapsed time: 0.29131s