tell

tell: a Python package to model future total electricity loads in the United States - Published in JOSS (2022)

https://github.com/immm-sfa/tell

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in JOSS metadata
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    4 of 10 committers (40.0%) from academic institutions
  • Institutional organization owner
    Organization immm-sfa has institutional domain (im3.pnnl.gov)
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Political Science Social Sciences - 90% confidence
Mathematics Computer Science - 84% confidence
Artificial Intelligence and Machine Learning Computer Science - 83% confidence
Last synced: 4 months ago · JSON representation

Repository

A model to predict Total ELectricity Loads (TELL)

Basic Info
Statistics
  • Stars: 27
  • Watchers: 6
  • Forks: 11
  • Open Issues: 4
  • Releases: 10
Created about 5 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License

README.md

build DOI

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)

bash 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

  • Name: Integrated Multisector Multiscale Modeling
  • Login: IMMM-SFA
  • Kind: organization
  • Location: Richland, WA

Models and code from the IM3 SFA

JOSS Publication

tell: a Python package to model future total electricity loads in the United States
Published
November 11, 2022
Volume 7, Issue 79, Page 4472
Authors
Casey R. McGrath ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Casey D. Burleyson ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Zarrar Khan ORCID
Joint Global Change Research Institute, PNNL, College Park, MD, USA
Aowabin Rahman ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Travis Thurber ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Chris R. Vernon ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Nathalie Voisin ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Jennie S. Rice ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Editor
Frauke Wiese ORCID
Tags
Electricity loads MultiSector Dynamics

GitHub Events

Total
  • Issues event: 4
  • Watch event: 4
  • 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: 4
  • 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

Last synced: 4 months ago

All Time
  • Total Commits: 586
  • Total Committers: 10
  • Avg Commits per committer: 58.6
  • Development Distribution Score (DDS): 0.626
Past Year
  • Commits: 38
  • Committers: 3
  • Avg Commits per committer: 12.667
  • Development Distribution Score (DDS): 0.421
Top Committers
Name Email 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 (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 16
  • Total pull requests: 53
  • 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.38
  • Average comments per pull request: 0.62
  • Merged pull requests: 50
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 11
  • Average time to close issues: about 1 hour
  • Average time to close pull requests: 3 days
  • Issue authors: 3
  • Pull request authors: 2
  • Average comments per issue: 0.25
  • Average comments per pull request: 0.27
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • euronion (9)
  • ValentinSatge (2)
  • cdburley (1)
  • SanPen (1)
  • raimundoatal (1)
  • ecooper-cu (1)
  • erexer (1)
Pull Request Authors
  • crvernon (24)
  • erexer (20)
  • cdburley (18)
  • mcgrathc (4)
  • thurber (2)
  • kyleniemeyer (2)
Top Labels
Issue Labels
bug (1)
Pull Request Labels
bug (5) enhancement (4) documentation (4) development (3) publication (2) tests (1)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 27 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 7
    (may contain duplicates)
  • Total versions: 30
  • Total maintainers: 3
proxy.golang.org: github.com/immm-sfa/tell
  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
proxy.golang.org: github.com/IMMM-SFA/tell
  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
pypi.org: tell

An open-source Python package to model future hourly total electricity loads.

  • Documentation: https://immm-sfa.github.io/tell
  • License: 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 over 1 year ago
  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 7
  • Downloads: 27 Last month
Rankings
Dependent repos count: 5.5%
Dependent packages count: 10.1%
Forks count: 11.4%
Stargazers count: 14.9%
Average: 15.3%
Downloads: 34.4%
Maintainers (3)
Last synced: 4 months ago

Dependencies

requirements.txt pypi
  • 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
setup.py pypi
  • 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
.github/workflows/build.yml actions
  • actions/checkout v1 composite
  • actions/setup-python master composite
  • codecov/codecov-action v1 composite
.github/workflows/deploy.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • ad-m/github-push-action master composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite