| Name | cosim-toolbox JSON |
| Version |
0.9.0
JSON |
| download |
| home_page | None |
| Summary | Python support for the CoSimulation Toolbox |
| upload_time | 2025-08-08 23:22:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
power system
transactive
energy
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
============
Introduction
============
Co-Simulation Toolbox to push advances in the field.
Installation
============
cosim_toolbox can be installed using pip_::
$ pip install cosim_toolbox
However, in order to be useful, cosim_toolbox needs custom versions of
GridLAB-D and other federates that work with HELICS. It also requires Python 3.10 or later, with
HELICS_, NumPy_, MongoDB_, Pandas_, and Psycopg_. There is reposistory of the complete
Co-Simulation for Windows, Linux and Mac OS X on GitHub. A Docker_ version is also available for users.
Development Work Flow for cosim_toolbox
=======================================
* From this directory, 'pip install -e .' points Python to this cloned repository for any calls to cosim_toolbox functions
* See the https://[github]/copper/tree/main/src/cosim_toolbox/cosim_toolbox for a roadmap of existing Python source files, and some documentation. Any changes or additions to the code need to be made in this directory.
* Run tests from any other directory on this computer
* When ready, edit the cosim_toolbox version number and dependencies in setup.py
* To deploy follow the instructions in the Python Packaging Guide:
1. Create an account on PyPI if you haven't yet.
2. Install twine and build: pip install twine build
3. Create the source distribution, change to cosim_toolbox directory execute: python3 -m build .
4. Check your distribution files for errors: twine check dist/*
5. (Optional) Upload to the PyPI test server first (note: separate user registration required): twine upload --repository-url https://test.pypi.org/legacy/ dist/*
6. Upload to PyPI: twine upload dist/*
* Any user gets the changes with 'pip install cosim_toolbox --upgrade'
* Use 'pip show cosim_toolbox' to verify the version and location on your computer
Using Co-Simulation Toolbox
===========================
This is a developer's platform for electric power grid research. See
http://cosimtoolbox.readthedocs.io/en/latest/ for user instructions, and
https://[github]/copper for source code.
Links to Dependencies
=====================
* Docker_
* GridLAB-D_
* HELICS_
* NumPy_
* MongoDB_
* Pandas_
* Psycopg_
* Python_
Subdirectories
==============
- *cosim_toolbox*; utilities for building and running co-simulations using HELICS federates.
- *test*; scripts that support testing the package; not automated.
License & Copyright
===================
- Copyright (c) 2022-2025 Battelle Memorial Institute
.. _Docker: https://www.docker.com
.. _GridLAB-D: http://gridlab-d.shoutwiki.com
.. _HELICS: https://helics.org
.. _NumPy: https://www.numpy.org
.. _MongoDB: https://www.mongodb.com
.. _Pandas: https://pandas.pydata.org
.. _Psycopg: https://www.psycopg.org/docs
.. _pip: https://pip.pypa.io/en/stable
.. _Python: https://www.python.org
Raw data
{
"_id": null,
"home_page": null,
"name": "cosim-toolbox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Mitch Pelton <mitch.pelton@pnnl.gov>, Fred Rutz <fredrick.rutz@pnnl.gov>, Nathan Gray <nathan.gray@pnnl.gov>, Trevor Hardy <trevor.hardy@pnnl.gov>",
"keywords": "power system, transactive, energy",
"author": null,
"author_email": "Trevor Hardy <trevor.hardy@pnnl.gov>",
"download_url": "https://files.pythonhosted.org/packages/8f/ce/15fe17ff4382c01ef8f30e2e5040860885499528ee4f159a20298df52aca/cosim_toolbox-0.9.0.tar.gz",
"platform": null,
"description": "============\nIntroduction\n============\n\nCo-Simulation Toolbox to push advances in the field.\n\nInstallation\n============\n\ncosim_toolbox can be installed using pip_::\n\n $ pip install cosim_toolbox\n\nHowever, in order to be useful, cosim_toolbox needs custom versions of\nGridLAB-D and other federates that work with HELICS. It also requires Python 3.10 or later, with\nHELICS_, NumPy_, MongoDB_, Pandas_, and Psycopg_. There is reposistory of the complete\nCo-Simulation for Windows, Linux and Mac OS X on GitHub. A Docker_ version is also available for users.\n\nDevelopment Work Flow for cosim_toolbox\n=======================================\n\n* From this directory, 'pip install -e .' points Python to this cloned repository for any calls to cosim_toolbox functions\n* See the https://[github]/copper/tree/main/src/cosim_toolbox/cosim_toolbox for a roadmap of existing Python source files, and some documentation. Any changes or additions to the code need to be made in this directory.\n* Run tests from any other directory on this computer\n* When ready, edit the cosim_toolbox version number and dependencies in setup.py\n* To deploy follow the instructions in the Python Packaging Guide:\n 1. Create an account on PyPI if you haven't yet.\n 2. Install twine and build: pip install twine build\n 3. Create the source distribution, change to cosim_toolbox directory execute: python3 -m build .\n 4. Check your distribution files for errors: twine check dist/*\n 5. (Optional) Upload to the PyPI test server first (note: separate user registration required): twine upload --repository-url https://test.pypi.org/legacy/ dist/*\n 6. Upload to PyPI: twine upload dist/*\n* Any user gets the changes with 'pip install cosim_toolbox --upgrade'\n* Use 'pip show cosim_toolbox' to verify the version and location on your computer\n\nUsing Co-Simulation Toolbox\n===========================\n\nThis is a developer's platform for electric power grid research. See \nhttp://cosimtoolbox.readthedocs.io/en/latest/ for user instructions, and\nhttps://[github]/copper for source code.\n\nLinks to Dependencies\n=====================\n\n* Docker_\n* GridLAB-D_\n* HELICS_\n* NumPy_\n* MongoDB_\n* Pandas_\n* Psycopg_\n* Python_\n\nSubdirectories\n==============\n\n- *cosim_toolbox*; utilities for building and running co-simulations using HELICS federates.\n- *test*; scripts that support testing the package; not automated.\n\nLicense & Copyright\n===================\n\n- Copyright (c) 2022-2025 Battelle Memorial Institute\n\n.. _Docker: https://www.docker.com\n.. _GridLAB-D: http://gridlab-d.shoutwiki.com\n.. _HELICS: https://helics.org\n.. _NumPy: https://www.numpy.org\n.. _MongoDB: https://www.mongodb.com\n.. _Pandas: https://pandas.pydata.org\n.. _Psycopg: https://www.psycopg.org/docs\n.. _pip: https://pip.pypa.io/en/stable\n.. _Python: https://www.python.org\n",
"bugtrack_url": null,
"license": null,
"summary": "Python support for the CoSimulation Toolbox",
"version": "0.9.0",
"project_urls": {
"Documentation": "https://cosim_toolbox.readthedocs.io",
"Homepage": "https://devops.pnnl.gov/e-comp/thrust-3/copper",
"Repository": "https://devops.pnnl.gov/e-comp/thrust-3/copper"
},
"split_keywords": [
"power system",
" transactive",
" energy"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8ff494785e9e952f640af94f93f31960801917cb1fbe00b9ebb5ff3863cf7030",
"md5": "eb5654c244712b2869ed1e81e62d10ff",
"sha256": "526f1704c8db3b6bc308f7dd8d8778f59630ca46be0fc52dfbc233fff877ae4d"
},
"downloads": -1,
"filename": "cosim_toolbox-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb5654c244712b2869ed1e81e62d10ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 48608,
"upload_time": "2025-08-08T23:22:04",
"upload_time_iso_8601": "2025-08-08T23:22:04.724790Z",
"url": "https://files.pythonhosted.org/packages/8f/f4/94785e9e952f640af94f93f31960801917cb1fbe00b9ebb5ff3863cf7030/cosim_toolbox-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8fce15fe17ff4382c01ef8f30e2e5040860885499528ee4f159a20298df52aca",
"md5": "6cfa0dc17888a48dc86da20ac1ab347d",
"sha256": "5a85c77a63fbb3536533010dd0572d1e67400e09f77a87d7d6fadbd873264a40"
},
"downloads": -1,
"filename": "cosim_toolbox-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "6cfa0dc17888a48dc86da20ac1ab347d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 44080,
"upload_time": "2025-08-08T23:22:05",
"upload_time_iso_8601": "2025-08-08T23:22:05.975881Z",
"url": "https://files.pythonhosted.org/packages/8f/ce/15fe17ff4382c01ef8f30e2e5040860885499528ee4f159a20298df52aca/cosim_toolbox-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-08 23:22:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cosim-toolbox"
}
