| Name | annular JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | model coupling for demoses |
| upload_time | 2025-07-30 13:54:36 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License
Copyright (c) 2024 Christian Doh Dinga, Sander Rijn
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 |
energy transition
flexibility
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Annular
| fair-software.eu recommendations | |
|:---------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| (1/5) code repository | [][repo-url] |
| (2/5) license | [][repo-url] |
| (3/5) community registry | [][demoses-rsd] |
| (4/5) citation | [![DOI][Zenodo-badge]][Zenodo-url] |
| (5/5) checklist | |
| howfairis | [](https://fair-software.eu) |
| **Other best practices** | |
| Software Version |  |
| Supported Python versions | ![Supported Python Versions][py-versions-badge] |
## Introduction
Annular is a setup for running coupled energy system models with the aim of modeling flexibility scheduling and the policy regulations that affect the behavior of flexibility providers.
### Name
**Why the name 'annular'?**
'Annular' means 'in the shape of a ring', with which we specifically think of the rings of Saturn, containing many moons or in other words satellites, just like the satellite models interacting with the central market model.
## Installation
You can install `annular` directly from [PyPI](https://pypi.org/project/annular/):
```bash
# Best practice: install in a virtual environment
python3 -m venv .venv
source .venv/bin/activate # Use `source .venv/Scripts/activate` on Windows
python3 -m pip install annular
```
Then you can run the `run_local.py` file as a commandline tool to run coupled simulations specified by config files.
```bash
python run_local.py examples/data/energy_model_coupling.ymmsl
# ...
# intermediate output appears here
# ...
```
Result files will appear in a `results/<CONFIG_NAME>_<TIMESTAMP>/` folder, where `<CONFIG_NAME>` is the name as defined
in the configuration file, and `<TIMESTAMP>` is a timestamp of when your experiment was run. This folder will include a
copy of the used configuration file for archival purposes.
See the built-in help for further details:
```bash
$ python3 run_local.py --help
usage: run_local.py [-h] [config_files ...]
positional arguments:
config_files Configuration files to run simulations for.
options:
-h, --help show this help message and exit
```
NOTE: The code is tested and compatible with python versions 3.10 and 3.11.
## Contributing
If you want to contribute to the development of annular,
have a look at the [contribution guidelines](CONTRIBUTING.md).
Further instructions can be found in[`README.dev.md`](README.dev.md)
## Citation
For citation information, see [`CITATION.cff`](CITATION.cff)
## Credits
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [NLeSC/python-template](https://github.com/NLeSC/python-template).
[repo-url]: https://gitlab.tudelft.nl/demoses/annular
[demoses-rsd]: https://www.research-software.nl/projects/demoses
[py-versions-badge]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue
[Zenodo-url]: https://doi.org/10.5281/zenodo.13144649
[Zenodo-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.13144649.svg
Raw data
{
"_id": null,
"home_page": null,
"name": "annular",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "energy transition, flexibility",
"author": null,
"author_email": "Christian Doh Dinga <c.dohdinga@tudelft.nl>, Sander van Rijn <s.vanrijn@esciencecenter.nl>",
"download_url": "https://files.pythonhosted.org/packages/a2/08/a8d7c47fa25984b1e7e1024ccca5545b2e855b7774bccbf1f054fd8f6416/annular-0.3.0.tar.gz",
"platform": null,
"description": "# Annular\n\n| fair-software.eu recommendations | |\n|:---------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| (1/5) code repository | [][repo-url] |\n| (2/5) license | [][repo-url] |\n| (3/5) community registry | [][demoses-rsd] |\n| (4/5) citation | [![DOI][Zenodo-badge]][Zenodo-url] |\n| (5/5) checklist | |\n| howfairis | [](https://fair-software.eu) |\n| **Other best practices** | |\n| Software Version |  |\n| Supported Python versions | ![Supported Python Versions][py-versions-badge] |\n\n\n## Introduction\n\nAnnular is a setup for running coupled energy system models with the aim of modeling flexibility scheduling and the policy regulations that affect the behavior of flexibility providers.\n\n### Name\n**Why the name 'annular'?**\n\n'Annular' means 'in the shape of a ring', with which we specifically think of the rings of Saturn, containing many moons or in other words satellites, just like the satellite models interacting with the central market model.\n\n## Installation\n\nYou can install `annular` directly from [PyPI](https://pypi.org/project/annular/):\n\n```bash\n# Best practice: install in a virtual environment\npython3 -m venv .venv\nsource .venv/bin/activate # Use `source .venv/Scripts/activate` on Windows\n\npython3 -m pip install annular\n```\n\nThen you can run the `run_local.py` file as a commandline tool to run coupled simulations specified by config files.\n\n```bash\npython run_local.py examples/data/energy_model_coupling.ymmsl\n# ...\n# intermediate output appears here\n# ...\n```\n\nResult files will appear in a `results/<CONFIG_NAME>_<TIMESTAMP>/` folder, where `<CONFIG_NAME>` is the name as defined\nin the configuration file, and `<TIMESTAMP>` is a timestamp of when your experiment was run. This folder will include a\ncopy of the used configuration file for archival purposes.\n\nSee the built-in help for further details:\n\n```bash\n$ python3 run_local.py --help\nusage: run_local.py [-h] [config_files ...]\n\npositional arguments:\n config_files Configuration files to run simulations for.\n\noptions:\n -h, --help show this help message and exit\n```\n\nNOTE: The code is tested and compatible with python versions 3.10 and 3.11.\n\n## Contributing\n\nIf you want to contribute to the development of annular,\nhave a look at the [contribution guidelines](CONTRIBUTING.md).\n\nFurther instructions can be found in[`README.dev.md`](README.dev.md)\n\n## Citation\n\nFor citation information, see [`CITATION.cff`](CITATION.cff)\n\n## Credits\n\nThis package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [NLeSC/python-template](https://github.com/NLeSC/python-template).\n\n[repo-url]: https://gitlab.tudelft.nl/demoses/annular\n[demoses-rsd]: https://www.research-software.nl/projects/demoses\n[py-versions-badge]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue\n[Zenodo-url]: https://doi.org/10.5281/zenodo.13144649\n[Zenodo-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.13144649.svg\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 Christian Doh Dinga, Sander Rijn\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "model coupling for demoses",
"version": "0.3.0",
"project_urls": {
"Changelog": "https://github.com/sjvrijn/annular/CHANGELOG.md",
"Issues": "https://github.com/sjvrijn/annular/issues",
"Repository": "https://github.com/sjvrijn/annular"
},
"split_keywords": [
"energy transition",
" flexibility"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8c677d61538fd08eef9940436a4442bb367eeda3d647b3a0c4db856c7b9c686c",
"md5": "4ca16b63c25c1d002526ce79d7dc4dc5",
"sha256": "32cda06d812dda38f8d9ea503c4756d52a84f2b8e3efb611130bf0055624326e"
},
"downloads": -1,
"filename": "annular-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ca16b63c25c1d002526ce79d7dc4dc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 36385,
"upload_time": "2025-07-30T13:54:34",
"upload_time_iso_8601": "2025-07-30T13:54:34.906200Z",
"url": "https://files.pythonhosted.org/packages/8c/67/7d61538fd08eef9940436a4442bb367eeda3d647b3a0c4db856c7b9c686c/annular-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a208a8d7c47fa25984b1e7e1024ccca5545b2e855b7774bccbf1f054fd8f6416",
"md5": "df880d569bac319990c2238f0d5f4e0e",
"sha256": "babf6f3f98d8e384cf149f57696ddbd8e048263bd9854fbaa7bfdc1494188678"
},
"downloads": -1,
"filename": "annular-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "df880d569bac319990c2238f0d5f4e0e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 1183262,
"upload_time": "2025-07-30T13:54:36",
"upload_time_iso_8601": "2025-07-30T13:54:36.739334Z",
"url": "https://files.pythonhosted.org/packages/a2/08/a8d7c47fa25984b1e7e1024ccca5545b2e855b7774bccbf1f054fd8f6416/annular-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 13:54:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sjvrijn",
"github_project": "annular",
"github_not_found": true,
"lcname": "annular"
}
