| Name | tesp-support JSON |
| Version |
1.3.6
JSON |
| download |
| home_page | None |
| Summary | Python APIs for the Transactive Energy Simulation Platform |
| upload_time | 2024-12-15 02:13:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | TESP License Version 1.0, April 2017 https://github.com/pnnl/tesp TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Battelle Memorial Institute (hereinafter Battelle) hereby grants permission to any person or entity lawfully obtaining a copy of this software and associated documentation files (hereinafter "the Software") to redistribute and use the Software in source and binary forms, with or without modification. Such person or entity may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and may permit others to do so, subject to the following conditions: - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers. - 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. - Other than as used herein, neither the name Battelle Memorial Institute or Battelle may be used in any form whatsoever without the express written consent of Battelle. 2. 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 BATTELLE 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. 3. The Software was produced by Battelle under Contract No. DE-AC05-76RL01830 with the Department of Energy. The U.S. Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. The specific term of the license can be identified by inquiry made to Battelle or DOE. Neither the United States nor the United States Department of Energy, nor any of their employees, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness or usefulness of any data, apparatus, product or process disclosed, or represents that its use would not infringe privately owned rights. END TERMS AND CONDITIONS For interested users: This software system was developed at PNNL with DOE funding [from the Office of Electricity], and PNNL also developed utility applications that are patent-protected and available for licensing for commercial use. More information can be found at PNNL’s Available Technologies site: http://availabletechnologies.pnnl.gov/ or by contacting peter.christensen@pnnl.gov |
| keywords |
power system
transactive
energy
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
colorama
duckdb
docutils
future
h5py
helics
importlib_resources
Jinja2
joblib
matplotlib
networkx
NREL-PySAM
numpy
openpyxl
pandas
plotly
psst
PuLP
PyGLM
pyjson5
Pyomo
PYPOWER
pyutilib
PyYAML
recommonmark
requests
resource
scikit-learn
scipy
seaborn
Sphinx
sphinxcontrib-bibtex
sphinx-jsonschema
sphinx-rtd-theme
tables
tesp_support
urllib3
xarray
xlrd
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
============
Introduction
============
Transactive Energy Simulation Platform (TESP) simulates
the electric power distribution grid with transactive control
of loads and resources. Current features include:
* GridLAB-D_ for the distribution system and residential loads
* EnergyPlus_ for large buildings
* MATPOWER_ or PYPOWER_ for the bulk power systems
* Bindings for transactive agents in Python_, Java or C++
The goal of TESP_ is that researchers can focus their work
on the last item, to push advances in the field.
Installation
============
tesp_support can be installed using pip_::
$ pip install tesp_support
However, in order to be useful, tesp_support needs custom versions of
GridLAB-D and EnergyPlus. It also requires Python 3.8 or later, with
NumPy_, SciPy_, NetworkX_, Matplotlib_ and PYPOWER_. There are
cross-platform installers of the complete TESP for Windows, Linux and Mac
OS X on GitHub. A Docker_ version is also available for users.
Development Work Flow for tesp_support
======================================
* From this directory, 'pip install -e .' points Python to this cloned repository for any calls to tesp_support functions
* See the https://github.com/pnnl/tesp/tree/master/src/tesp_support/tesp_support 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 tesp_support 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 tesp_support 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 tesp_support --upgrade'
* Use 'pip show tesp_support' to verify the version and location on your computer
Using TESP
==========
This is a developer's platform for electric power grid research. See
http://tesp.readthedocs.io/en/latest/ for user instructions, and
http://github.com/pnnl/tesp for source code.
Links to Dependencies
=====================
* Docker_
* EnergyPlus_
* GridLAB-D_
* Matplotlib_
* MATPOWER_
* NetworkX_
* NumPy_
* Pandas_
* pip_
* PYPOWER_
* Python_
* SciPy_
* TESP_
Subdirectories
==============
- *tesp_support*; utilities for building and running using PYPOWER with or without FNCS/HELICS co-simulations.
- *test*; scripts that support testing the package; not automated.
License & Copyright
===================
- Copyright (c) 2017-2024 Battelle Memorial Institute
- See LICENSE file at https://github.com/pnnl/tesp
.. _Docker: https://www.docker.com
.. _EnergyPlus: https://energyplus.net
.. _GridLAB-D: http://gridlab-d.shoutwiki.com
.. _Matplotlib: https://www.matplotlib.org
.. _MATPOWER: https://www.matpower.org
.. _NetworkX: https://www.networkx.org
.. _NumPy: https://www.numpy.org
.. _Pandas: https://pandas.pydata.org
.. _pip: https://pip.pypa.io/en/stable
.. _PYPOWER: https://github.com/rwl/PYPOWER
.. _Python: https://www.python.org
.. _SciPy: https://www.scipy.org
.. _TESP: https://tesp.readthedocs.io/en/latest
Raw data
{
"_id": null,
"home_page": null,
"name": "tesp-support",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Mitch Pelton <mitch.pelton@pnnl.gov>, Fred Rutz <fredrick.rutz@pnnl.gov>, Jessica Kerby <jessica.kerby@pnn.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/1a/1e/4a15973c8c5b271e52a1f7e4b1590c5a4b962d6108eb47aacc640380ab7f/tesp_support-1.3.6.tar.gz",
"platform": null,
"description": "============\nIntroduction\n============\n\nTransactive Energy Simulation Platform (TESP) simulates \nthe electric power distribution grid with transactive control\nof loads and resources. Current features include:\n\n* GridLAB-D_ for the distribution system and residential loads\n* EnergyPlus_ for large buildings\n* MATPOWER_ or PYPOWER_ for the bulk power systems\n* Bindings for transactive agents in Python_, Java or C++\n\nThe goal of TESP_ is that researchers can focus their work\non the last item, to push advances in the field.\n\nInstallation\n============\n\ntesp_support can be installed using pip_::\n\n $ pip install tesp_support\n\nHowever, in order to be useful, tesp_support needs custom versions of \nGridLAB-D and EnergyPlus. It also requires Python 3.8 or later, with\nNumPy_, SciPy_, NetworkX_, Matplotlib_ and PYPOWER_. There are \ncross-platform installers of the complete TESP for Windows, Linux and Mac \nOS X on GitHub. A Docker_ version is also available for users. \n\nDevelopment Work Flow for tesp_support\n======================================\n\n* From this directory, 'pip install -e .' points Python to this cloned repository for any calls to tesp_support functions\n* See the https://github.com/pnnl/tesp/tree/master/src/tesp_support/tesp_support 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 tesp_support 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 tesp_support 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 tesp_support --upgrade'\n* Use 'pip show tesp_support' to verify the version and location on your computer\n\nUsing TESP\n==========\n\nThis is a developer's platform for electric power grid research. See \nhttp://tesp.readthedocs.io/en/latest/ for user instructions, and \nhttp://github.com/pnnl/tesp for source code. \n\nLinks to Dependencies\n=====================\n\n* Docker_\n* EnergyPlus_\n* GridLAB-D_\n* Matplotlib_\n* MATPOWER_\n* NetworkX_\n* NumPy_\n* Pandas_\n* pip_\n* PYPOWER_\n* Python_\n* SciPy_\n* TESP_\n\nSubdirectories\n==============\n\n- *tesp_support*; utilities for building and running using PYPOWER with or without FNCS/HELICS co-simulations.\n- *test*; scripts that support testing the package; not automated.\n\nLicense & Copyright\n===================\n\n- Copyright (c) 2017-2024 Battelle Memorial Institute\n- See LICENSE file at https://github.com/pnnl/tesp\n\n.. _Docker: https://www.docker.com\n.. _EnergyPlus: https://energyplus.net\n.. _GridLAB-D: http://gridlab-d.shoutwiki.com\n.. _Matplotlib: https://www.matplotlib.org\n.. _MATPOWER: https://www.matpower.org\n.. _NetworkX: https://www.networkx.org\n.. _NumPy: https://www.numpy.org\n.. _Pandas: https://pandas.pydata.org\n.. _pip: https://pip.pypa.io/en/stable\n.. _PYPOWER: https://github.com/rwl/PYPOWER\n.. _Python: https://www.python.org\n.. _SciPy: https://www.scipy.org\n.. _TESP: https://tesp.readthedocs.io/en/latest\n",
"bugtrack_url": null,
"license": "TESP License Version 1.0, April 2017 https://github.com/pnnl/tesp TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Battelle Memorial Institute (hereinafter Battelle) hereby grants permission to any person or entity lawfully obtaining a copy of this software and associated documentation files (hereinafter \"the Software\") to redistribute and use the Software in source and binary forms, with or without modification. Such person or entity may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and may permit others to do so, subject to the following conditions: - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers. - 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. - Other than as used herein, neither the name Battelle Memorial Institute or Battelle may be used in any form whatsoever without the express written consent of Battelle. 2. 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 BATTELLE 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. 3. The Software was produced by Battelle under Contract No. DE-AC05-76RL01830 with the Department of Energy. The U.S. Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. The specific term of the license can be identified by inquiry made to Battelle or DOE. Neither the United States nor the United States Department of Energy, nor any of their employees, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness or usefulness of any data, apparatus, product or process disclosed, or represents that its use would not infringe privately owned rights. END TERMS AND CONDITIONS For interested users: This software system was developed at PNNL with DOE funding [from the Office of Electricity], and PNNL also developed utility applications that are patent-protected and available for licensing for commercial use. More information can be found at PNNL\u2019s Available Technologies site: http://availabletechnologies.pnnl.gov/ or by contacting peter.christensen@pnnl.gov",
"summary": "Python APIs for the Transactive Energy Simulation Platform",
"version": "1.3.6",
"project_urls": {
"Documentation": "https://tesp.readthedocs.io",
"Homepage": "https://github.com/pnnl/tesp",
"Repository": "https://github.com/pnnl/tesp"
},
"split_keywords": [
"power system",
" transactive",
" energy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cbb0ab701953712924d7e6e96b29d4bb270573b5bb135ca8a71f097b46ca49b2",
"md5": "94fdab3ed0b56e04427e490c96db39be",
"sha256": "77b5b0b99525bc94edddf73b117817e9e79f1eb5eeec0786d328b84e84edff59"
},
"downloads": -1,
"filename": "tesp_support-1.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "94fdab3ed0b56e04427e490c96db39be",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 14935277,
"upload_time": "2024-12-15T02:13:01",
"upload_time_iso_8601": "2024-12-15T02:13:01.947475Z",
"url": "https://files.pythonhosted.org/packages/cb/b0/ab701953712924d7e6e96b29d4bb270573b5bb135ca8a71f097b46ca49b2/tesp_support-1.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a1e4a15973c8c5b271e52a1f7e4b1590c5a4b962d6108eb47aacc640380ab7f",
"md5": "37e0844179a621e2ac8f071fa9b518c3",
"sha256": "bd2f26061207b563c1f2cdbe725ff5fb4428452d3f9b15267afb957fd4fc3cbc"
},
"downloads": -1,
"filename": "tesp_support-1.3.6.tar.gz",
"has_sig": false,
"md5_digest": "37e0844179a621e2ac8f071fa9b518c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 13707683,
"upload_time": "2024-12-15T02:13:06",
"upload_time_iso_8601": "2024-12-15T02:13:06.726458Z",
"url": "https://files.pythonhosted.org/packages/1a/1e/4a15973c8c5b271e52a1f7e4b1590c5a4b962d6108eb47aacc640380ab7f/tesp_support-1.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-15 02:13:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pnnl",
"github_project": "tesp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "colorama",
"specs": [
[
"~=",
"0.4.6"
]
]
},
{
"name": "duckdb",
"specs": [
[
"~=",
"1.1.2"
]
]
},
{
"name": "docutils",
"specs": [
[
"~=",
"0.21.2"
]
]
},
{
"name": "future",
"specs": [
[
"~=",
"1.0.0"
]
]
},
{
"name": "h5py",
"specs": [
[
"~=",
"3.12.1"
]
]
},
{
"name": "helics",
"specs": [
[
"~=",
"3.5.3"
]
]
},
{
"name": "importlib_resources",
"specs": [
[
"~=",
"6.4.5"
]
]
},
{
"name": "Jinja2",
"specs": [
[
"~=",
"3.1.4"
]
]
},
{
"name": "joblib",
"specs": [
[
"~=",
"1.4.2"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"~=",
"3.9.2"
]
]
},
{
"name": "networkx",
"specs": [
[
"~=",
"3.3"
]
]
},
{
"name": "NREL-PySAM",
"specs": [
[
"~=",
"5.1.0"
]
]
},
{
"name": "numpy",
"specs": [
[
"~=",
"1.26.4"
]
]
},
{
"name": "openpyxl",
"specs": [
[
"~=",
"3.1.5"
]
]
},
{
"name": "pandas",
"specs": [
[
"~=",
"2.2.2"
]
]
},
{
"name": "plotly",
"specs": [
[
"~=",
"5.24.0"
]
]
},
{
"name": "psst",
"specs": []
},
{
"name": "PuLP",
"specs": [
[
"~=",
"2.9.0"
]
]
},
{
"name": "PyGLM",
"specs": [
[
"~=",
"2.7.1"
]
]
},
{
"name": "pyjson5",
"specs": [
[
"~=",
"1.6.7"
]
]
},
{
"name": "Pyomo",
"specs": [
[
"==",
"6.5.0"
]
]
},
{
"name": "PYPOWER",
"specs": [
[
"==",
"5.1.16"
]
]
},
{
"name": "pyutilib",
"specs": [
[
"==",
"6.0.0"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"~=",
"6.0.2"
]
]
},
{
"name": "recommonmark",
"specs": [
[
"~=",
"0.7.1"
]
]
},
{
"name": "requests",
"specs": [
[
"~=",
"2.32.3"
]
]
},
{
"name": "resource",
"specs": [
[
"~=",
"0.2.1"
]
]
},
{
"name": "scikit-learn",
"specs": [
[
"~=",
"1.5.1"
]
]
},
{
"name": "scipy",
"specs": [
[
"~=",
"1.14.1"
]
]
},
{
"name": "seaborn",
"specs": [
[
"~=",
"0.13.2"
]
]
},
{
"name": "Sphinx",
"specs": [
[
"~=",
"8.1.3"
]
]
},
{
"name": "sphinxcontrib-bibtex",
"specs": [
[
"~=",
"2.6.3"
]
]
},
{
"name": "sphinx-jsonschema",
"specs": [
[
"~=",
"1.19.1"
]
]
},
{
"name": "sphinx-rtd-theme",
"specs": [
[
"~=",
"3.0.2"
]
]
},
{
"name": "tables",
"specs": [
[
"~=",
"3.10.1"
]
]
},
{
"name": "tesp_support",
"specs": []
},
{
"name": "urllib3",
"specs": [
[
"~=",
"2.2.3"
]
]
},
{
"name": "xarray",
"specs": [
[
"~=",
"2024.9.0"
]
]
},
{
"name": "xlrd",
"specs": [
[
"~=",
"2.0.1"
]
]
}
],
"lcname": "tesp-support"
}
