tell
An open-source Python package to model future hourly total electricity loads.
https://github.com/IMMM-SFA/tell
Category: Energy Systems
Sub Category: Load and Demand Forecasting
Last synced: about 18 hours ago
JSON representation
Repository metadata
A model to predict Total ELectricity Loads (TELL)
- Host: GitHub
- URL: https://github.com/IMMM-SFA/tell
- Owner: IMMM-SFA
- License: bsd-2-clause
- Created: 2020-10-20T18:42:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-25T17:34:12.000Z (2 months ago)
- Last Synced: 2025-04-22T08:06:21.168Z (6 days ago)
- Language: Python
- Homepage: https://immm-sfa.github.io/tell/
- Size: 202 MB
- Stars: 27
- Watchers: 5
- Forks: 11
- Open Issues: 4
- Releases: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
README.md
tell
tell is an open-source Python package to model future hourly total electricity loads.
Purpose
tell was created to:
-
Project the short- and long-term evolution of hourly electricity demand in response to changes in weather and climate.
-
Work at a spatial resolution adequate for input to a unit commitment/economic dispatch (UC/ED) model.
-
Maintain consistency with the long-term growth and evolution of annual state-level electricity demand projected by an economically driven human-Earth system model.
Install tell
tell is available via GitHub repository by using the pip install functionality. tell requires a Python version between 3.8 and 4.0 as well as a pip install to import the package. tell has been tested on
Windows and Mac platforms. (Note: For those installing on Windows, tell is supported by GeoPandas functionality. Please see suggestions for installing GeoPandas on Windows here:
https://geopandas.org/en/stable/getting_started/install.html)
pip install tell
Check out a quickstarter tutorial to run tell
Run tell using the quickstarter tutorial: Quickstarter.
Getting started
New to tell? Get familiar with what tell is all about in our Getting Started documentation.
User guide
Our User Guide provides in-depth information on the key concepts of tell and how the model works.
Contributing to tell
Whether you find a typo in the documentation, find a bug, or want to develop functionality that you think will make tell more robust, you are welcome to contribute. Please see our Contribution Guidelines for more details.
API reference
The API Reference contains a detailed description of the tell API. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts.
Contact/Help
Need help with tell or have a comment? Please open a new Issue with your question/comments.
Owner metadata
- Name: Integrated Multisector Multiscale Modeling
- Login: IMMM-SFA
- Email:
- Kind: organization
- Description: Models and code from the IM3 SFA
- Website: https://im3.pnnl.gov/
- Location: Richland, WA
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/31457237?v=4
- Repositories: 45
- Last ynced at: 2023-03-04T02:34:30.243Z
- Profile URL: https://github.com/IMMM-SFA
GitHub Events
Total
- Issues event: 4
- Watch event: 3
- Delete event: 2
- Issue comment event: 2
- Push event: 7
- Pull request review event: 1
- Pull request event: 3
- Fork event: 1
- Create event: 6
Last Year
- Issues event: 4
- Watch event: 3
- Delete event: 2
- Issue comment event: 2
- Push event: 7
- Pull request review event: 1
- Pull request event: 3
- Fork event: 1
- Create event: 6
Committers metadata
Last synced: 8 days ago
Total Commits: 586
Total Committers: 10
Avg Commits per committer: 58.6
Development Distribution Score (DDS): 0.626
Commits in past year: 38
Committers in past year: 3
Avg Commits per committer in past year: 12.667
Development Distribution Score (DDS) in past year: 0.421
| Name | Commits | |
|---|---|---|
| Casey Burleyson | c****n@p****v | 219 |
| Chris Vernon | c****n@g****m | 159 |
| Casey McGrath | m****c@h****u | 151 |
| Casey D. Burleyson | 3****y | 27 |
| erexer | 1****r | 10 |
| Casey McGrath | 3****c | 9 |
| Kyle Niemeyer | k****r@f****m | 3 |
| Rahman, Aowabin | a****n@p****v | 3 |
| Travis Thurber | t****r | 3 |
| thurber | t****r@p****v | 2 |
Committer domains:
- pnnl.gov: 3
- fastmail.com: 1
- hawaii.edu: 1
Issue and Pull Request metadata
Last synced: 2 days ago
Total issues: 16
Total pull requests: 54
Average time to close issues: about 1 month
Average time to close pull requests: 8 days
Total issue authors: 7
Total pull request authors: 6
Average comments per issue: 1.44
Average comments per pull request: 0.61
Merged pull request: 51
Bot issues: 0
Bot pull requests: 0
Past year issues: 6
Past year pull requests: 18
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 2 days
Past year issue authors: 5
Past year pull request authors: 3
Past year average comments per issue: 0.33
Past year average comments per pull request: 0.17
Past year merged pull request: 17
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- euronion (9)
- ValentinSatge (2)
- cdburley (1)
- SanPen (1)
- raimundoatal (1)
- ecooper-cu (1)
- erexer (1)
Top Pull Request Authors
- crvernon (20)
- cdburley (16)
- erexer (10)
- mcgrathc (4)
- thurber (2)
- kyleniemeyer (2)
Top Issue Labels
- bug (1)
Top Pull Request Labels
- bug (4)
- enhancement (4)
- documentation (4)
- development (3)
- publication (2)
- tests (1)
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 277 last-month
- Total dependent packages: 0
- Total dependent repositories: 7
- Total versions: 10
- Total maintainers: 3
pypi.org: tell
An open-source Python package to model future hourly total electricity loads.
- Homepage:
- Documentation: https://immm-sfa.github.io/tell
- Licenses: Copyright 2022 Battelle Memorial Institute Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. 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. 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 THE COPYRIGHT HOLDER 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.
- Latest release: 1.3.0 (published 7 months ago)
- Last Synced: 2025-04-26T14:37:04.228Z (2 days ago)
- Versions: 10
- Dependent Packages: 0
- Dependent Repositories: 7
- Downloads: 277 Last month
-
Rankings:
- Dependent repos count: 5.539%
- Dependent packages count: 10.118%
- Forks count: 11.407%
- Stargazers count: 14.896%
- Average: 15.264%
- Downloads: 34.358%
- Maintainers (3)
Dependencies
- Fiona >=1.8.21
- Pillow >=9.0.1
- PyMeeus >=0.5.11
- PyYAML >=6.0
- Rtree >=0.9.7
- Shapely >=1.8.0
- attrs >=21.4.0
- certifi >=2021.10.8
- charset-normalizer >=2.0.12
- click >=8.0.3
- click-plugins >=1.1.1
- cligj >=0.7.2
- convertdate >=2.4.0
- cycler >=0.11.0
- fonttools >=4.29.1
- geopandas >=0.10.2
- hijri-converter >=2.2.3
- holidays >=0.13
- idna >=3.3
- joblib >=1.1.0
- kiwisolver >=1.3.2
- korean-lunar-calendar >=0.2.1
- matplotlib >=3.5.1
- munch >=2.5.0
- numpy >=1.21.5
- openpyxl >=3.0.9
- packaging >=21.3
- pandas >=1.3.5
- pyparsing >=3.0.7
- pyproj >=3.2.1
- python-dateutil >=2.8.2
- pytz >=2021.3
- requests >=2.27.1
- scikit-learn ==1.0.2
- scipy >=1.7.3
- setuptools >=49.2.1
- six >=1.16.0
- sklearn >=0.0
- threadpoolctl >=3.1.0
- tqdm >=4.63.0
- urllib3 >=1.26.8
- Fiona >=1.8.21
- Pillow >=9.0.1
- PyMeeus >=0.5.11
- PyYAML >=6.0
- Rtree >=0.9.7
- Shapely >=1.8.0
- attrs >=21.4.0
- certifi >=2021.10.8
- charset-normalizer >=2.0.12
- click >=8.0.3
- click-plugins >=1.1.1
- cligj >=0.7.2
- convertdate >=2.4.0
- cycler >=0.11.0
- fonttools >=4.29.1
- geopandas >=0.10.2
- hijri-converter >=2.2.3
- holidays >=0.13
- idna >=3.3
- joblib >=1.1.0
- kiwisolver >=1.3.2
- korean-lunar-calendar >=0.2.1
- matplotlib >=3.5.1
- munch >=2.5.0
- numpy >=1.21.5
- openpyxl >=3.0.9
- packaging >=21.3
- pandas >=1.3.5
- pyparsing >=3.0.7
- pyproj >=3.2.1
- python-dateutil >=2.8.2
- pytz >=2021.3
- requests >=2.27.1
- scikit-learn ==1.0.2
- scipy >=1.7.3
- setuptools >=49.2.1
- six >=1.16.0
- sklearn >=0.0
- threadpoolctl >=3.1.0
- urllib3 >=1.26.8
- actions/checkout v1 composite
- actions/setup-python master composite
- codecov/codecov-action v1 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- ad-m/github-push-action master composite
- actions/checkout v2 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
Score: 11.396054513238813