Home

Awesome

build DOI

tell

tell is an open-source Python package to model future hourly total electricity loads.

Purpose

tell was created to:

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.